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/sched/signal.h>
27 #include <linux/uio.h>
28 #include <asm/unaligned.h>
30 #include <linux/usb/composite.h>
31 #include <linux/usb/functionfs.h>
33 #include <linux/aio.h>
34 #include <linux/mmu_context.h>
35 #include <linux/poll.h>
36 #include <linux/eventfd.h>
40 #include "u_os_desc.h"
43 #define FUNCTIONFS_MAGIC 0xa647361 /* Chosen by a honest dice roll ;) */
45 /* Reference counter handling */
46 static void ffs_data_get(struct ffs_data *ffs);
47 static void ffs_data_put(struct ffs_data *ffs);
48 /* Creates new ffs_data object. */
49 static struct ffs_data *__must_check ffs_data_new(const char *dev_name)
50 __attribute__((malloc));
52 /* Opened counter handling. */
53 static void ffs_data_opened(struct ffs_data *ffs);
54 static void ffs_data_closed(struct ffs_data *ffs);
56 /* Called with ffs->mutex held; take over ownership of data. */
57 static int __must_check
58 __ffs_data_got_descs(struct ffs_data *ffs, char *data, size_t len);
59 static int __must_check
60 __ffs_data_got_strings(struct ffs_data *ffs, char *data, size_t len);
63 /* The function structure ***************************************************/
68 struct usb_configuration *conf;
69 struct usb_gadget *gadget;
74 short *interfaces_nums;
76 struct usb_function function;
80 static struct ffs_function *ffs_func_from_usb(struct usb_function *f)
82 return container_of(f, struct ffs_function, function);
86 static inline enum ffs_setup_state
87 ffs_setup_state_clear_cancelled(struct ffs_data *ffs)
89 return (enum ffs_setup_state)
90 cmpxchg(&ffs->setup_state, FFS_SETUP_CANCELLED, FFS_NO_SETUP);
94 static void ffs_func_eps_disable(struct ffs_function *func);
95 static int __must_check ffs_func_eps_enable(struct ffs_function *func);
97 static int ffs_func_bind(struct usb_configuration *,
98 struct usb_function *);
99 static int ffs_func_set_alt(struct usb_function *, unsigned, unsigned);
100 static void ffs_func_disable(struct usb_function *);
101 static int ffs_func_setup(struct usb_function *,
102 const struct usb_ctrlrequest *);
103 static bool ffs_func_req_match(struct usb_function *,
104 const struct usb_ctrlrequest *,
106 static void ffs_func_suspend(struct usb_function *);
107 static void ffs_func_resume(struct usb_function *);
110 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num);
111 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf);
114 /* The endpoints structures *************************************************/
117 struct usb_ep *ep; /* P: ffs->eps_lock */
118 struct usb_request *req; /* P: epfile->mutex */
120 /* [0]: full speed, [1]: high speed, [2]: super speed */
121 struct usb_endpoint_descriptor *descs[3];
125 int status; /* P: epfile->mutex */
129 /* Protects ep->ep and ep->req. */
132 struct ffs_data *ffs;
133 struct ffs_ep *ep; /* P: ffs->eps_lock */
135 struct dentry *dentry;
138 * Buffer for holding data from partial reads which may happen since
139 * we’re rounding user read requests to a multiple of a max packet size.
141 * The pointer is initialised with NULL value and may be set by
142 * __ffs_epfile_read_data function to point to a temporary buffer.
144 * In normal operation, calls to __ffs_epfile_read_buffered will consume
145 * data from said buffer and eventually free it. Importantly, while the
146 * function is using the buffer, it sets the pointer to NULL. This is
147 * all right since __ffs_epfile_read_data and __ffs_epfile_read_buffered
148 * can never run concurrently (they are synchronised by epfile->mutex)
149 * so the latter will not assign a new value to the pointer.
151 * Meanwhile ffs_func_eps_disable frees the buffer (if the pointer is
152 * valid) and sets the pointer to READ_BUFFER_DROP value. This special
153 * value is crux of the synchronisation between ffs_func_eps_disable and
154 * __ffs_epfile_read_data.
156 * Once __ffs_epfile_read_data is about to finish it will try to set the
157 * pointer back to its old value (as described above), but seeing as the
158 * pointer is not-NULL (namely READ_BUFFER_DROP) it will instead free
161 * == State transitions ==
163 * • ptr == NULL: (initial state)
164 * ◦ __ffs_epfile_read_buffer_free: go to ptr == DROP
165 * ◦ __ffs_epfile_read_buffered: nop
166 * ◦ __ffs_epfile_read_data allocates temp buffer: go to ptr == buf
167 * ◦ reading finishes: n/a, not in ‘and reading’ state
169 * ◦ __ffs_epfile_read_buffer_free: nop
170 * ◦ __ffs_epfile_read_buffered: go to ptr == NULL
171 * ◦ __ffs_epfile_read_data allocates temp buffer: free buf, nop
172 * ◦ reading finishes: n/a, not in ‘and reading’ state
174 * ◦ __ffs_epfile_read_buffer_free: free buf, go to ptr == DROP
175 * ◦ __ffs_epfile_read_buffered: go to ptr == NULL and reading
176 * ◦ __ffs_epfile_read_data: n/a, __ffs_epfile_read_buffered
177 * is always called first
178 * ◦ reading finishes: n/a, not in ‘and reading’ state
179 * • ptr == NULL and reading:
180 * ◦ __ffs_epfile_read_buffer_free: go to ptr == DROP and reading
181 * ◦ __ffs_epfile_read_buffered: n/a, mutex is held
182 * ◦ __ffs_epfile_read_data: n/a, mutex is held
183 * ◦ reading finishes and …
184 * … all data read: free buf, go to ptr == NULL
185 * … otherwise: go to ptr == buf and reading
186 * • ptr == DROP and reading:
187 * ◦ __ffs_epfile_read_buffer_free: nop
188 * ◦ __ffs_epfile_read_buffered: n/a, mutex is held
189 * ◦ __ffs_epfile_read_data: n/a, mutex is held
190 * ◦ reading finishes: free buf, go to ptr == DROP
192 struct ffs_buffer *read_buffer;
193 #define READ_BUFFER_DROP ((struct ffs_buffer *)ERR_PTR(-ESHUTDOWN))
197 unsigned char in; /* P: ffs->eps_lock */
198 unsigned char isoc; /* P: ffs->eps_lock */
209 /* ffs_io_data structure ***************************************************/
216 struct iov_iter data;
220 struct mm_struct *mm;
221 struct work_struct work;
224 struct usb_request *req;
226 struct ffs_data *ffs;
229 struct ffs_desc_helper {
230 struct ffs_data *ffs;
231 unsigned interfaces_count;
235 static int __must_check ffs_epfiles_create(struct ffs_data *ffs);
236 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count);
238 static struct dentry *
239 ffs_sb_create_file(struct super_block *sb, const char *name, void *data,
240 const struct file_operations *fops);
242 /* Devices management *******************************************************/
244 DEFINE_MUTEX(ffs_lock);
245 EXPORT_SYMBOL_GPL(ffs_lock);
247 static struct ffs_dev *_ffs_find_dev(const char *name);
248 static struct ffs_dev *_ffs_alloc_dev(void);
249 static void _ffs_free_dev(struct ffs_dev *dev);
250 static int ffs_acquire_dev(const char *dev_name, struct ffs_data *ffs_data);
251 static void ffs_release_dev(struct ffs_dev *ffs_dev);
252 static int ffs_ready(struct ffs_data *ffs);
253 static void ffs_closed(struct ffs_data *ffs);
255 /* Misc helper functions ****************************************************/
257 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
258 __attribute__((warn_unused_result, nonnull));
259 static char *ffs_prepare_buffer(const char __user *buf, size_t len)
260 __attribute__((warn_unused_result, nonnull));
263 /* Control file aka ep0 *****************************************************/
265 static void ffs_ep0_complete(struct usb_ep *ep, struct usb_request *req)
267 struct ffs_data *ffs = req->context;
269 complete(&ffs->ep0req_completion);
272 static int __ffs_ep0_queue_wait(struct ffs_data *ffs, char *data, size_t len)
274 struct usb_request *req = ffs->ep0req;
277 req->zero = len < le16_to_cpu(ffs->ev.setup.wLength);
279 spin_unlock_irq(&ffs->ev.waitq.lock);
285 * UDC layer requires to provide a buffer even for ZLP, but should
286 * not use it at all. Let's provide some poisoned pointer to catch
287 * possible bug in the driver.
289 if (req->buf == NULL)
290 req->buf = (void *)0xDEADBABE;
292 reinit_completion(&ffs->ep0req_completion);
294 ret = usb_ep_queue(ffs->gadget->ep0, req, GFP_ATOMIC);
295 if (unlikely(ret < 0))
298 ret = wait_for_completion_interruptible(&ffs->ep0req_completion);
300 usb_ep_dequeue(ffs->gadget->ep0, req);
304 ffs->setup_state = FFS_NO_SETUP;
305 return req->status ? req->status : req->actual;
308 static int __ffs_ep0_stall(struct ffs_data *ffs)
310 if (ffs->ev.can_stall) {
311 pr_vdebug("ep0 stall\n");
312 usb_ep_set_halt(ffs->gadget->ep0);
313 ffs->setup_state = FFS_NO_SETUP;
316 pr_debug("bogus ep0 stall!\n");
321 static ssize_t ffs_ep0_write(struct file *file, const char __user *buf,
322 size_t len, loff_t *ptr)
324 struct ffs_data *ffs = file->private_data;
330 /* Fast check if setup was canceled */
331 if (ffs_setup_state_clear_cancelled(ffs) == FFS_SETUP_CANCELLED)
335 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
336 if (unlikely(ret < 0))
340 switch (ffs->state) {
341 case FFS_READ_DESCRIPTORS:
342 case FFS_READ_STRINGS:
344 if (unlikely(len < 16)) {
349 data = ffs_prepare_buffer(buf, len);
356 if (ffs->state == FFS_READ_DESCRIPTORS) {
357 pr_info("read descriptors\n");
358 ret = __ffs_data_got_descs(ffs, data, len);
359 if (unlikely(ret < 0))
362 ffs->state = FFS_READ_STRINGS;
365 pr_info("read strings\n");
366 ret = __ffs_data_got_strings(ffs, data, len);
367 if (unlikely(ret < 0))
370 ret = ffs_epfiles_create(ffs);
372 ffs->state = FFS_CLOSING;
376 ffs->state = FFS_ACTIVE;
377 mutex_unlock(&ffs->mutex);
379 ret = ffs_ready(ffs);
380 if (unlikely(ret < 0)) {
381 ffs->state = FFS_CLOSING;
392 * We're called from user space, we can use _irq
393 * rather then _irqsave
395 spin_lock_irq(&ffs->ev.waitq.lock);
396 switch (ffs_setup_state_clear_cancelled(ffs)) {
397 case FFS_SETUP_CANCELLED:
405 case FFS_SETUP_PENDING:
409 /* FFS_SETUP_PENDING */
410 if (!(ffs->ev.setup.bRequestType & USB_DIR_IN)) {
411 spin_unlock_irq(&ffs->ev.waitq.lock);
412 ret = __ffs_ep0_stall(ffs);
416 /* FFS_SETUP_PENDING and not stall */
417 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
419 spin_unlock_irq(&ffs->ev.waitq.lock);
421 data = ffs_prepare_buffer(buf, len);
427 spin_lock_irq(&ffs->ev.waitq.lock);
430 * We are guaranteed to be still in FFS_ACTIVE state
431 * but the state of setup could have changed from
432 * FFS_SETUP_PENDING to FFS_SETUP_CANCELLED so we need
433 * to check for that. If that happened we copied data
434 * from user space in vain but it's unlikely.
436 * For sure we are not in FFS_NO_SETUP since this is
437 * the only place FFS_SETUP_PENDING -> FFS_NO_SETUP
438 * transition can be performed and it's protected by
441 if (ffs_setup_state_clear_cancelled(ffs) ==
442 FFS_SETUP_CANCELLED) {
445 spin_unlock_irq(&ffs->ev.waitq.lock);
447 /* unlocks spinlock */
448 ret = __ffs_ep0_queue_wait(ffs, data, len);
458 mutex_unlock(&ffs->mutex);
462 /* Called with ffs->ev.waitq.lock and ffs->mutex held, both released on exit. */
463 static ssize_t __ffs_ep0_read_events(struct ffs_data *ffs, char __user *buf,
467 * n cannot be bigger than ffs->ev.count, which cannot be bigger than
468 * size of ffs->ev.types array (which is four) so that's how much space
471 struct usb_functionfs_event events[ARRAY_SIZE(ffs->ev.types)];
472 const size_t size = n * sizeof *events;
475 memset(events, 0, size);
478 events[i].type = ffs->ev.types[i];
479 if (events[i].type == FUNCTIONFS_SETUP) {
480 events[i].u.setup = ffs->ev.setup;
481 ffs->setup_state = FFS_SETUP_PENDING;
487 memmove(ffs->ev.types, ffs->ev.types + n,
488 ffs->ev.count * sizeof *ffs->ev.types);
490 spin_unlock_irq(&ffs->ev.waitq.lock);
491 mutex_unlock(&ffs->mutex);
493 return unlikely(copy_to_user(buf, events, size)) ? -EFAULT : size;
496 static ssize_t ffs_ep0_read(struct file *file, char __user *buf,
497 size_t len, loff_t *ptr)
499 struct ffs_data *ffs = file->private_data;
506 /* Fast check if setup was canceled */
507 if (ffs_setup_state_clear_cancelled(ffs) == FFS_SETUP_CANCELLED)
511 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
512 if (unlikely(ret < 0))
516 if (ffs->state != FFS_ACTIVE) {
522 * We're called from user space, we can use _irq rather then
525 spin_lock_irq(&ffs->ev.waitq.lock);
527 switch (ffs_setup_state_clear_cancelled(ffs)) {
528 case FFS_SETUP_CANCELLED:
533 n = len / sizeof(struct usb_functionfs_event);
539 if ((file->f_flags & O_NONBLOCK) && !ffs->ev.count) {
544 if (wait_event_interruptible_exclusive_locked_irq(ffs->ev.waitq,
550 return __ffs_ep0_read_events(ffs, buf,
551 min(n, (size_t)ffs->ev.count));
553 case FFS_SETUP_PENDING:
554 if (ffs->ev.setup.bRequestType & USB_DIR_IN) {
555 spin_unlock_irq(&ffs->ev.waitq.lock);
556 ret = __ffs_ep0_stall(ffs);
560 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
562 spin_unlock_irq(&ffs->ev.waitq.lock);
565 data = kmalloc(len, GFP_KERNEL);
566 if (unlikely(!data)) {
572 spin_lock_irq(&ffs->ev.waitq.lock);
574 /* See ffs_ep0_write() */
575 if (ffs_setup_state_clear_cancelled(ffs) ==
576 FFS_SETUP_CANCELLED) {
581 /* unlocks spinlock */
582 ret = __ffs_ep0_queue_wait(ffs, data, len);
583 if (likely(ret > 0) && unlikely(copy_to_user(buf, data, len)))
592 spin_unlock_irq(&ffs->ev.waitq.lock);
594 mutex_unlock(&ffs->mutex);
599 static int ffs_ep0_open(struct inode *inode, struct file *file)
601 struct ffs_data *ffs = inode->i_private;
605 if (unlikely(ffs->state == FFS_CLOSING))
608 file->private_data = ffs;
609 ffs_data_opened(ffs);
614 static int ffs_ep0_release(struct inode *inode, struct file *file)
616 struct ffs_data *ffs = file->private_data;
620 ffs_data_closed(ffs);
625 static long ffs_ep0_ioctl(struct file *file, unsigned code, unsigned long value)
627 struct ffs_data *ffs = file->private_data;
628 struct usb_gadget *gadget = ffs->gadget;
633 if (code == FUNCTIONFS_INTERFACE_REVMAP) {
634 struct ffs_function *func = ffs->func;
635 ret = func ? ffs_func_revmap_intf(func, value) : -ENODEV;
636 } else if (gadget && gadget->ops->ioctl) {
637 ret = gadget->ops->ioctl(gadget, code, value);
645 static unsigned int ffs_ep0_poll(struct file *file, poll_table *wait)
647 struct ffs_data *ffs = file->private_data;
648 unsigned int mask = POLLWRNORM;
651 poll_wait(file, &ffs->ev.waitq, wait);
653 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
654 if (unlikely(ret < 0))
657 switch (ffs->state) {
658 case FFS_READ_DESCRIPTORS:
659 case FFS_READ_STRINGS:
664 switch (ffs->setup_state) {
670 case FFS_SETUP_PENDING:
671 case FFS_SETUP_CANCELLED:
672 mask |= (POLLIN | POLLOUT);
677 case FFS_DEACTIVATED:
681 mutex_unlock(&ffs->mutex);
686 static const struct file_operations ffs_ep0_operations = {
689 .open = ffs_ep0_open,
690 .write = ffs_ep0_write,
691 .read = ffs_ep0_read,
692 .release = ffs_ep0_release,
693 .unlocked_ioctl = ffs_ep0_ioctl,
694 .poll = ffs_ep0_poll,
698 /* "Normal" endpoints operations ********************************************/
700 static void ffs_epfile_io_complete(struct usb_ep *_ep, struct usb_request *req)
703 if (likely(req->context)) {
704 struct ffs_ep *ep = _ep->driver_data;
705 ep->status = req->status ? req->status : req->actual;
706 complete(req->context);
710 static ssize_t ffs_copy_to_iter(void *data, int data_len, struct iov_iter *iter)
712 ssize_t ret = copy_to_iter(data, data_len, iter);
713 if (likely(ret == data_len))
716 if (unlikely(iov_iter_count(iter)))
720 * Dear user space developer!
722 * TL;DR: To stop getting below error message in your kernel log, change
723 * user space code using functionfs to align read buffers to a max
726 * Some UDCs (e.g. dwc3) require request sizes to be a multiple of a max
727 * packet size. When unaligned buffer is passed to functionfs, it
728 * internally uses a larger, aligned buffer so that such UDCs are happy.
730 * Unfortunately, this means that host may send more data than was
731 * requested in read(2) system call. f_fs doesn’t know what to do with
732 * that excess data so it simply drops it.
734 * Was the buffer aligned in the first place, no such problem would
737 * Data may be dropped only in AIO reads. Synchronous reads are handled
738 * by splitting a request into multiple parts. This splitting may still
739 * be a problem though so it’s likely best to align the buffer
740 * regardless of it being AIO or not..
742 * This only affects OUT endpoints, i.e. reading data with a read(2),
743 * aio_read(2) etc. system calls. Writing data to an IN endpoint is not
746 pr_err("functionfs read size %d > requested size %zd, dropping excess data. "
747 "Align read buffer size to max packet size to avoid the problem.\n",
753 static void ffs_user_copy_worker(struct work_struct *work)
755 struct ffs_io_data *io_data = container_of(work, struct ffs_io_data,
757 int ret = io_data->req->status ? io_data->req->status :
758 io_data->req->actual;
759 bool kiocb_has_eventfd = io_data->kiocb->ki_flags & IOCB_EVENTFD;
761 if (io_data->read && ret > 0) {
762 mm_segment_t oldfs = get_fs();
766 ret = ffs_copy_to_iter(io_data->buf, ret, &io_data->data);
767 unuse_mm(io_data->mm);
771 io_data->kiocb->ki_complete(io_data->kiocb, ret, ret);
773 if (io_data->ffs->ffs_eventfd && !kiocb_has_eventfd)
774 eventfd_signal(io_data->ffs->ffs_eventfd, 1);
776 usb_ep_free_request(io_data->ep, io_data->req);
779 kfree(io_data->to_free);
784 static void ffs_epfile_async_io_complete(struct usb_ep *_ep,
785 struct usb_request *req)
787 struct ffs_io_data *io_data = req->context;
788 struct ffs_data *ffs = io_data->ffs;
792 INIT_WORK(&io_data->work, ffs_user_copy_worker);
793 queue_work(ffs->io_completion_wq, &io_data->work);
796 static void __ffs_epfile_read_buffer_free(struct ffs_epfile *epfile)
799 * See comment in struct ffs_epfile for full read_buffer pointer
800 * synchronisation story.
802 struct ffs_buffer *buf = xchg(&epfile->read_buffer, READ_BUFFER_DROP);
803 if (buf && buf != READ_BUFFER_DROP)
807 /* Assumes epfile->mutex is held. */
808 static ssize_t __ffs_epfile_read_buffered(struct ffs_epfile *epfile,
809 struct iov_iter *iter)
812 * Null out epfile->read_buffer so ffs_func_eps_disable does not free
813 * the buffer while we are using it. See comment in struct ffs_epfile
814 * for full read_buffer pointer synchronisation story.
816 struct ffs_buffer *buf = xchg(&epfile->read_buffer, NULL);
818 if (!buf || buf == READ_BUFFER_DROP)
821 ret = copy_to_iter(buf->data, buf->length, iter);
822 if (buf->length == ret) {
827 if (unlikely(iov_iter_count(iter))) {
834 if (cmpxchg(&epfile->read_buffer, NULL, buf))
840 /* Assumes epfile->mutex is held. */
841 static ssize_t __ffs_epfile_read_data(struct ffs_epfile *epfile,
842 void *data, int data_len,
843 struct iov_iter *iter)
845 struct ffs_buffer *buf;
847 ssize_t ret = copy_to_iter(data, data_len, iter);
848 if (likely(data_len == ret))
851 if (unlikely(iov_iter_count(iter)))
854 /* See ffs_copy_to_iter for more context. */
855 pr_warn("functionfs read size %d > requested size %zd, splitting request into multiple reads.",
859 buf = kmalloc(sizeof(*buf) + data_len, GFP_KERNEL);
862 buf->length = data_len;
863 buf->data = buf->storage;
864 memcpy(buf->storage, data + ret, data_len);
867 * At this point read_buffer is NULL or READ_BUFFER_DROP (if
868 * ffs_func_eps_disable has been called in the meanwhile). See comment
869 * in struct ffs_epfile for full read_buffer pointer synchronisation
872 if (unlikely(cmpxchg(&epfile->read_buffer, NULL, buf)))
878 static ssize_t ffs_epfile_io(struct file *file, struct ffs_io_data *io_data)
880 struct ffs_epfile *epfile = file->private_data;
881 struct usb_request *req;
884 ssize_t ret, data_len = -EINVAL;
887 /* Are we still active? */
888 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
891 /* Wait for endpoint to be enabled */
894 if (file->f_flags & O_NONBLOCK)
897 ret = wait_event_interruptible(
898 epfile->ffs->wait, (ep = epfile->ep));
904 halt = (!io_data->read == !epfile->in);
905 if (halt && epfile->isoc)
908 /* We will be using request and read_buffer */
909 ret = ffs_mutex_lock(&epfile->mutex, file->f_flags & O_NONBLOCK);
913 /* Allocate & copy */
915 struct usb_gadget *gadget;
918 * Do we have buffered data from previous partial read? Check
919 * that for synchronous case only because we do not have
920 * facility to ‘wake up’ a pending asynchronous read and push
921 * buffered data to it which we would need to make things behave
924 if (!io_data->aio && io_data->read) {
925 ret = __ffs_epfile_read_buffered(epfile, &io_data->data);
931 * if we _do_ wait above, the epfile->ffs->gadget might be NULL
932 * before the waiting completes, so do not assign to 'gadget'
935 gadget = epfile->ffs->gadget;
937 spin_lock_irq(&epfile->ffs->eps_lock);
938 /* In the meantime, endpoint got disabled or changed. */
939 if (epfile->ep != ep) {
943 data_len = iov_iter_count(&io_data->data);
945 * Controller may require buffer size to be aligned to
946 * maxpacketsize of an out endpoint.
949 data_len = usb_ep_align_maybe(gadget, ep->ep, data_len);
950 spin_unlock_irq(&epfile->ffs->eps_lock);
952 data = kmalloc(data_len, GFP_KERNEL);
953 if (unlikely(!data)) {
957 if (!io_data->read &&
958 !copy_from_iter_full(data, data_len, &io_data->data)) {
964 spin_lock_irq(&epfile->ffs->eps_lock);
966 if (epfile->ep != ep) {
967 /* In the meantime, endpoint got disabled or changed. */
970 ret = usb_ep_set_halt(ep->ep);
973 } else if (unlikely(data_len == -EINVAL)) {
975 * Sanity Check: even though data_len can't be used
976 * uninitialized at the time I write this comment, some
977 * compilers complain about this situation.
978 * In order to keep the code clean from warnings, data_len is
979 * being initialized to -EINVAL during its declaration, which
980 * means we can't rely on compiler anymore to warn no future
981 * changes won't result in data_len being used uninitialized.
982 * For such reason, we're adding this redundant sanity check
985 WARN(1, "%s: data_len == -EINVAL\n", __func__);
987 } else if (!io_data->aio) {
988 DECLARE_COMPLETION_ONSTACK(done);
989 bool interrupted = false;
993 req->length = data_len;
995 req->context = &done;
996 req->complete = ffs_epfile_io_complete;
998 ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
999 if (unlikely(ret < 0))
1002 spin_unlock_irq(&epfile->ffs->eps_lock);
1004 if (unlikely(wait_for_completion_interruptible(&done))) {
1006 * To avoid race condition with ffs_epfile_io_complete,
1007 * dequeue the request first then check
1008 * status. usb_ep_dequeue API should guarantee no race
1009 * condition with req->complete callback.
1011 usb_ep_dequeue(ep->ep, req);
1012 wait_for_completion(&done);
1013 interrupted = ep->status < 0;
1018 else if (io_data->read && ep->status > 0)
1019 ret = __ffs_epfile_read_data(epfile, data, ep->status,
1024 } else if (!(req = usb_ep_alloc_request(ep->ep, GFP_ATOMIC))) {
1028 req->length = data_len;
1030 io_data->buf = data;
1031 io_data->ep = ep->ep;
1033 io_data->ffs = epfile->ffs;
1035 req->context = io_data;
1036 req->complete = ffs_epfile_async_io_complete;
1038 ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
1039 if (unlikely(ret)) {
1040 io_data->req = NULL;
1041 usb_ep_free_request(ep->ep, req);
1047 * Do not kfree the buffer in this function. It will be freed
1048 * by ffs_user_copy_worker.
1054 spin_unlock_irq(&epfile->ffs->eps_lock);
1056 mutex_unlock(&epfile->mutex);
1063 ffs_epfile_open(struct inode *inode, struct file *file)
1065 struct ffs_epfile *epfile = inode->i_private;
1069 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
1072 file->private_data = epfile;
1073 ffs_data_opened(epfile->ffs);
1078 static int ffs_aio_cancel(struct kiocb *kiocb)
1080 struct ffs_io_data *io_data = kiocb->private;
1081 struct ffs_epfile *epfile = kiocb->ki_filp->private_data;
1082 unsigned long flags;
1087 spin_lock_irqsave(&epfile->ffs->eps_lock, flags);
1089 if (likely(io_data && io_data->ep && io_data->req))
1090 value = usb_ep_dequeue(io_data->ep, io_data->req);
1094 spin_unlock_irqrestore(&epfile->ffs->eps_lock, flags);
1099 static ssize_t ffs_epfile_write_iter(struct kiocb *kiocb, struct iov_iter *from)
1101 struct ffs_io_data io_data, *p = &io_data;
1106 if (!is_sync_kiocb(kiocb)) {
1107 p = kzalloc(sizeof(io_data), GFP_KERNEL);
1112 memset(p, 0, sizeof(*p));
1119 p->mm = current->mm;
1124 kiocb_set_cancel_fn(kiocb, ffs_aio_cancel);
1126 res = ffs_epfile_io(kiocb->ki_filp, p);
1127 if (res == -EIOCBQUEUED)
1136 static ssize_t ffs_epfile_read_iter(struct kiocb *kiocb, struct iov_iter *to)
1138 struct ffs_io_data io_data, *p = &io_data;
1143 if (!is_sync_kiocb(kiocb)) {
1144 p = kzalloc(sizeof(io_data), GFP_KERNEL);
1149 memset(p, 0, sizeof(*p));
1156 p->to_free = dup_iter(&p->data, to, GFP_KERNEL);
1165 p->mm = current->mm;
1170 kiocb_set_cancel_fn(kiocb, ffs_aio_cancel);
1172 res = ffs_epfile_io(kiocb->ki_filp, p);
1173 if (res == -EIOCBQUEUED)
1186 ffs_epfile_release(struct inode *inode, struct file *file)
1188 struct ffs_epfile *epfile = inode->i_private;
1192 __ffs_epfile_read_buffer_free(epfile);
1193 ffs_data_closed(epfile->ffs);
1198 static long ffs_epfile_ioctl(struct file *file, unsigned code,
1199 unsigned long value)
1201 struct ffs_epfile *epfile = file->private_data;
1207 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
1210 /* Wait for endpoint to be enabled */
1213 if (file->f_flags & O_NONBLOCK)
1216 ret = wait_event_interruptible(
1217 epfile->ffs->wait, (ep = epfile->ep));
1222 spin_lock_irq(&epfile->ffs->eps_lock);
1224 /* In the meantime, endpoint got disabled or changed. */
1225 if (epfile->ep != ep) {
1226 spin_unlock_irq(&epfile->ffs->eps_lock);
1231 case FUNCTIONFS_FIFO_STATUS:
1232 ret = usb_ep_fifo_status(epfile->ep->ep);
1234 case FUNCTIONFS_FIFO_FLUSH:
1235 usb_ep_fifo_flush(epfile->ep->ep);
1238 case FUNCTIONFS_CLEAR_HALT:
1239 ret = usb_ep_clear_halt(epfile->ep->ep);
1241 case FUNCTIONFS_ENDPOINT_REVMAP:
1242 ret = epfile->ep->num;
1244 case FUNCTIONFS_ENDPOINT_DESC:
1247 struct usb_endpoint_descriptor desc1, *desc;
1249 switch (epfile->ffs->gadget->speed) {
1250 case USB_SPEED_SUPER:
1251 case USB_SPEED_SUPER_PLUS:
1254 case USB_SPEED_HIGH:
1261 desc = epfile->ep->descs[desc_idx];
1262 memcpy(&desc1, desc, desc->bLength);
1264 spin_unlock_irq(&epfile->ffs->eps_lock);
1265 ret = copy_to_user((void *)value, &desc1, desc1.bLength);
1273 spin_unlock_irq(&epfile->ffs->eps_lock);
1278 static const struct file_operations ffs_epfile_operations = {
1279 .llseek = no_llseek,
1281 .open = ffs_epfile_open,
1282 .write_iter = ffs_epfile_write_iter,
1283 .read_iter = ffs_epfile_read_iter,
1284 .release = ffs_epfile_release,
1285 .unlocked_ioctl = ffs_epfile_ioctl,
1289 /* File system and super block operations ***********************************/
1292 * Mounting the file system creates a controller file, used first for
1293 * function configuration then later for event monitoring.
1296 static struct inode *__must_check
1297 ffs_sb_make_inode(struct super_block *sb, void *data,
1298 const struct file_operations *fops,
1299 const struct inode_operations *iops,
1300 struct ffs_file_perms *perms)
1302 struct inode *inode;
1306 inode = new_inode(sb);
1308 if (likely(inode)) {
1309 struct timespec ts = current_time(inode);
1311 inode->i_ino = get_next_ino();
1312 inode->i_mode = perms->mode;
1313 inode->i_uid = perms->uid;
1314 inode->i_gid = perms->gid;
1315 inode->i_atime = ts;
1316 inode->i_mtime = ts;
1317 inode->i_ctime = ts;
1318 inode->i_private = data;
1320 inode->i_fop = fops;
1328 /* Create "regular" file */
1329 static struct dentry *ffs_sb_create_file(struct super_block *sb,
1330 const char *name, void *data,
1331 const struct file_operations *fops)
1333 struct ffs_data *ffs = sb->s_fs_info;
1334 struct dentry *dentry;
1335 struct inode *inode;
1339 dentry = d_alloc_name(sb->s_root, name);
1340 if (unlikely(!dentry))
1343 inode = ffs_sb_make_inode(sb, data, fops, NULL, &ffs->file_perms);
1344 if (unlikely(!inode)) {
1349 d_add(dentry, inode);
1354 static const struct super_operations ffs_sb_operations = {
1355 .statfs = simple_statfs,
1356 .drop_inode = generic_delete_inode,
1359 struct ffs_sb_fill_data {
1360 struct ffs_file_perms perms;
1362 const char *dev_name;
1364 struct ffs_data *ffs_data;
1367 static int ffs_sb_fill(struct super_block *sb, void *_data, int silent)
1369 struct ffs_sb_fill_data *data = _data;
1370 struct inode *inode;
1371 struct ffs_data *ffs = data->ffs_data;
1376 data->ffs_data = NULL;
1377 sb->s_fs_info = ffs;
1378 sb->s_blocksize = PAGE_SIZE;
1379 sb->s_blocksize_bits = PAGE_SHIFT;
1380 sb->s_magic = FUNCTIONFS_MAGIC;
1381 sb->s_op = &ffs_sb_operations;
1382 sb->s_time_gran = 1;
1385 data->perms.mode = data->root_mode;
1386 inode = ffs_sb_make_inode(sb, NULL,
1387 &simple_dir_operations,
1388 &simple_dir_inode_operations,
1390 sb->s_root = d_make_root(inode);
1391 if (unlikely(!sb->s_root))
1395 if (unlikely(!ffs_sb_create_file(sb, "ep0", ffs,
1396 &ffs_ep0_operations)))
1402 static int ffs_fs_parse_opts(struct ffs_sb_fill_data *data, char *opts)
1406 if (!opts || !*opts)
1410 unsigned long value;
1414 comma = strchr(opts, ',');
1419 eq = strchr(opts, '=');
1420 if (unlikely(!eq)) {
1421 pr_err("'=' missing in %s\n", opts);
1427 if (kstrtoul(eq + 1, 0, &value)) {
1428 pr_err("%s: invalid value: %s\n", opts, eq + 1);
1432 /* Interpret option */
1433 switch (eq - opts) {
1435 if (!memcmp(opts, "no_disconnect", 13))
1436 data->no_disconnect = !!value;
1441 if (!memcmp(opts, "rmode", 5))
1442 data->root_mode = (value & 0555) | S_IFDIR;
1443 else if (!memcmp(opts, "fmode", 5))
1444 data->perms.mode = (value & 0666) | S_IFREG;
1450 if (!memcmp(opts, "mode", 4)) {
1451 data->root_mode = (value & 0555) | S_IFDIR;
1452 data->perms.mode = (value & 0666) | S_IFREG;
1459 if (!memcmp(opts, "uid", 3)) {
1460 data->perms.uid = make_kuid(current_user_ns(), value);
1461 if (!uid_valid(data->perms.uid)) {
1462 pr_err("%s: unmapped value: %lu\n", opts, value);
1465 } else if (!memcmp(opts, "gid", 3)) {
1466 data->perms.gid = make_kgid(current_user_ns(), value);
1467 if (!gid_valid(data->perms.gid)) {
1468 pr_err("%s: unmapped value: %lu\n", opts, value);
1478 pr_err("%s: invalid option\n", opts);
1482 /* Next iteration */
1491 /* "mount -t functionfs dev_name /dev/function" ends up here */
1493 static struct dentry *
1494 ffs_fs_mount(struct file_system_type *t, int flags,
1495 const char *dev_name, void *opts)
1497 struct ffs_sb_fill_data data = {
1499 .mode = S_IFREG | 0600,
1500 .uid = GLOBAL_ROOT_UID,
1501 .gid = GLOBAL_ROOT_GID,
1503 .root_mode = S_IFDIR | 0500,
1504 .no_disconnect = false,
1508 struct ffs_data *ffs;
1512 ret = ffs_fs_parse_opts(&data, opts);
1513 if (unlikely(ret < 0))
1514 return ERR_PTR(ret);
1516 ffs = ffs_data_new(dev_name);
1518 return ERR_PTR(-ENOMEM);
1519 ffs->file_perms = data.perms;
1520 ffs->no_disconnect = data.no_disconnect;
1522 ffs->dev_name = kstrdup(dev_name, GFP_KERNEL);
1523 if (unlikely(!ffs->dev_name)) {
1525 return ERR_PTR(-ENOMEM);
1528 ret = ffs_acquire_dev(dev_name, ffs);
1531 return ERR_PTR(ret);
1533 data.ffs_data = ffs;
1535 rv = mount_nodev(t, flags, &data, ffs_sb_fill);
1536 if (IS_ERR(rv) && data.ffs_data)
1537 ffs_data_put(data.ffs_data);
1542 ffs_fs_kill_sb(struct super_block *sb)
1546 kill_litter_super(sb);
1548 ffs_data_closed(sb->s_fs_info);
1551 static struct file_system_type ffs_fs_type = {
1552 .owner = THIS_MODULE,
1553 .name = "functionfs",
1554 .mount = ffs_fs_mount,
1555 .kill_sb = ffs_fs_kill_sb,
1557 MODULE_ALIAS_FS("functionfs");
1560 /* Driver's main init/cleanup functions *************************************/
1562 static int functionfs_init(void)
1568 ret = register_filesystem(&ffs_fs_type);
1570 pr_info("file system registered\n");
1572 pr_err("failed registering file system (%d)\n", ret);
1577 static void functionfs_cleanup(void)
1581 pr_info("unloading\n");
1582 unregister_filesystem(&ffs_fs_type);
1586 /* ffs_data and ffs_function construction and destruction code **************/
1588 static void ffs_data_clear(struct ffs_data *ffs);
1589 static void ffs_data_reset(struct ffs_data *ffs);
1591 static void ffs_data_get(struct ffs_data *ffs)
1595 refcount_inc(&ffs->ref);
1598 static void ffs_data_opened(struct ffs_data *ffs)
1602 refcount_inc(&ffs->ref);
1603 if (atomic_add_return(1, &ffs->opened) == 1 &&
1604 ffs->state == FFS_DEACTIVATED) {
1605 ffs->state = FFS_CLOSING;
1606 ffs_data_reset(ffs);
1610 static void ffs_data_put(struct ffs_data *ffs)
1614 if (unlikely(refcount_dec_and_test(&ffs->ref))) {
1615 pr_info("%s(): freeing\n", __func__);
1616 ffs_data_clear(ffs);
1617 ffs_release_dev(ffs->private_data);
1618 BUG_ON(waitqueue_active(&ffs->ev.waitq) ||
1619 waitqueue_active(&ffs->ep0req_completion.wait) ||
1620 waitqueue_active(&ffs->wait));
1621 destroy_workqueue(ffs->io_completion_wq);
1622 kfree(ffs->dev_name);
1627 static void ffs_data_closed(struct ffs_data *ffs)
1631 if (atomic_dec_and_test(&ffs->opened)) {
1632 if (ffs->no_disconnect) {
1633 ffs->state = FFS_DEACTIVATED;
1635 ffs_epfiles_destroy(ffs->epfiles,
1637 ffs->epfiles = NULL;
1639 if (ffs->setup_state == FFS_SETUP_PENDING)
1640 __ffs_ep0_stall(ffs);
1642 ffs->state = FFS_CLOSING;
1643 ffs_data_reset(ffs);
1646 if (atomic_read(&ffs->opened) < 0) {
1647 ffs->state = FFS_CLOSING;
1648 ffs_data_reset(ffs);
1654 static struct ffs_data *ffs_data_new(const char *dev_name)
1656 struct ffs_data *ffs = kzalloc(sizeof *ffs, GFP_KERNEL);
1662 ffs->io_completion_wq = alloc_ordered_workqueue("%s", 0, dev_name);
1663 if (!ffs->io_completion_wq) {
1668 refcount_set(&ffs->ref, 1);
1669 atomic_set(&ffs->opened, 0);
1670 ffs->state = FFS_READ_DESCRIPTORS;
1671 mutex_init(&ffs->mutex);
1672 spin_lock_init(&ffs->eps_lock);
1673 init_waitqueue_head(&ffs->ev.waitq);
1674 init_waitqueue_head(&ffs->wait);
1675 init_completion(&ffs->ep0req_completion);
1677 /* XXX REVISIT need to update it in some places, or do we? */
1678 ffs->ev.can_stall = 1;
1683 static void ffs_data_clear(struct ffs_data *ffs)
1689 BUG_ON(ffs->gadget);
1692 ffs_epfiles_destroy(ffs->epfiles, ffs->eps_count);
1694 if (ffs->ffs_eventfd)
1695 eventfd_ctx_put(ffs->ffs_eventfd);
1697 kfree(ffs->raw_descs_data);
1698 kfree(ffs->raw_strings);
1699 kfree(ffs->stringtabs);
1702 static void ffs_data_reset(struct ffs_data *ffs)
1706 ffs_data_clear(ffs);
1708 ffs->epfiles = NULL;
1709 ffs->raw_descs_data = NULL;
1710 ffs->raw_descs = NULL;
1711 ffs->raw_strings = NULL;
1712 ffs->stringtabs = NULL;
1714 ffs->raw_descs_length = 0;
1715 ffs->fs_descs_count = 0;
1716 ffs->hs_descs_count = 0;
1717 ffs->ss_descs_count = 0;
1719 ffs->strings_count = 0;
1720 ffs->interfaces_count = 0;
1725 ffs->state = FFS_READ_DESCRIPTORS;
1726 ffs->setup_state = FFS_NO_SETUP;
1729 ffs->ms_os_descs_ext_prop_count = 0;
1730 ffs->ms_os_descs_ext_prop_name_len = 0;
1731 ffs->ms_os_descs_ext_prop_data_len = 0;
1735 static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
1737 struct usb_gadget_strings **lang;
1742 if (WARN_ON(ffs->state != FFS_ACTIVE
1743 || test_and_set_bit(FFS_FL_BOUND, &ffs->flags)))
1746 first_id = usb_string_ids_n(cdev, ffs->strings_count);
1747 if (unlikely(first_id < 0))
1750 ffs->ep0req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL);
1751 if (unlikely(!ffs->ep0req))
1753 ffs->ep0req->complete = ffs_ep0_complete;
1754 ffs->ep0req->context = ffs;
1756 lang = ffs->stringtabs;
1758 for (; *lang; ++lang) {
1759 struct usb_string *str = (*lang)->strings;
1761 for (; str->s; ++id, ++str)
1766 ffs->gadget = cdev->gadget;
1771 static void functionfs_unbind(struct ffs_data *ffs)
1775 if (!WARN_ON(!ffs->gadget)) {
1776 usb_ep_free_request(ffs->gadget->ep0, ffs->ep0req);
1779 clear_bit(FFS_FL_BOUND, &ffs->flags);
1784 static int ffs_epfiles_create(struct ffs_data *ffs)
1786 struct ffs_epfile *epfile, *epfiles;
1791 count = ffs->eps_count;
1792 epfiles = kcalloc(count, sizeof(*epfiles), GFP_KERNEL);
1797 for (i = 1; i <= count; ++i, ++epfile) {
1799 mutex_init(&epfile->mutex);
1800 if (ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
1801 sprintf(epfile->name, "ep%02x", ffs->eps_addrmap[i]);
1803 sprintf(epfile->name, "ep%u", i);
1804 epfile->dentry = ffs_sb_create_file(ffs->sb, epfile->name,
1806 &ffs_epfile_operations);
1807 if (unlikely(!epfile->dentry)) {
1808 ffs_epfiles_destroy(epfiles, i - 1);
1813 ffs->epfiles = epfiles;
1817 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count)
1819 struct ffs_epfile *epfile = epfiles;
1823 for (; count; --count, ++epfile) {
1824 BUG_ON(mutex_is_locked(&epfile->mutex));
1825 if (epfile->dentry) {
1826 d_delete(epfile->dentry);
1827 dput(epfile->dentry);
1828 epfile->dentry = NULL;
1835 static void ffs_func_eps_disable(struct ffs_function *func)
1837 struct ffs_ep *ep = func->eps;
1838 struct ffs_epfile *epfile = func->ffs->epfiles;
1839 unsigned count = func->ffs->eps_count;
1840 unsigned long flags;
1842 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1844 /* pending requests get nuked */
1846 usb_ep_disable(ep->ep);
1851 __ffs_epfile_read_buffer_free(epfile);
1855 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1858 static int ffs_func_eps_enable(struct ffs_function *func)
1860 struct ffs_data *ffs = func->ffs;
1861 struct ffs_ep *ep = func->eps;
1862 struct ffs_epfile *epfile = ffs->epfiles;
1863 unsigned count = ffs->eps_count;
1864 unsigned long flags;
1867 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1869 ep->ep->driver_data = ep;
1871 ret = config_ep_by_speed(func->gadget, &func->function, ep->ep);
1873 pr_err("%s: config_ep_by_speed(%s) returned %d\n",
1874 __func__, ep->ep->name, ret);
1878 ret = usb_ep_enable(ep->ep);
1881 epfile->in = usb_endpoint_dir_in(ep->ep->desc);
1882 epfile->isoc = usb_endpoint_xfer_isoc(ep->ep->desc);
1891 wake_up_interruptible(&ffs->wait);
1892 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1898 /* Parsing and building descriptors and strings *****************************/
1901 * This validates if data pointed by data is a valid USB descriptor as
1902 * well as record how many interfaces, endpoints and strings are
1903 * required by given configuration. Returns address after the
1904 * descriptor or NULL if data is invalid.
1907 enum ffs_entity_type {
1908 FFS_DESCRIPTOR, FFS_INTERFACE, FFS_STRING, FFS_ENDPOINT
1911 enum ffs_os_desc_type {
1912 FFS_OS_DESC, FFS_OS_DESC_EXT_COMPAT, FFS_OS_DESC_EXT_PROP
1915 typedef int (*ffs_entity_callback)(enum ffs_entity_type entity,
1917 struct usb_descriptor_header *desc,
1920 typedef int (*ffs_os_desc_callback)(enum ffs_os_desc_type entity,
1921 struct usb_os_desc_header *h, void *data,
1922 unsigned len, void *priv);
1924 static int __must_check ffs_do_single_desc(char *data, unsigned len,
1925 ffs_entity_callback entity,
1928 struct usb_descriptor_header *_ds = (void *)data;
1934 /* At least two bytes are required: length and type */
1936 pr_vdebug("descriptor too short\n");
1940 /* If we have at least as many bytes as the descriptor takes? */
1941 length = _ds->bLength;
1943 pr_vdebug("descriptor longer then available data\n");
1947 #define __entity_check_INTERFACE(val) 1
1948 #define __entity_check_STRING(val) (val)
1949 #define __entity_check_ENDPOINT(val) ((val) & USB_ENDPOINT_NUMBER_MASK)
1950 #define __entity(type, val) do { \
1951 pr_vdebug("entity " #type "(%02x)\n", (val)); \
1952 if (unlikely(!__entity_check_ ##type(val))) { \
1953 pr_vdebug("invalid entity's value\n"); \
1956 ret = entity(FFS_ ##type, &val, _ds, priv); \
1957 if (unlikely(ret < 0)) { \
1958 pr_debug("entity " #type "(%02x); ret = %d\n", \
1964 /* Parse descriptor depending on type. */
1965 switch (_ds->bDescriptorType) {
1969 case USB_DT_DEVICE_QUALIFIER:
1970 /* function can't have any of those */
1971 pr_vdebug("descriptor reserved for gadget: %d\n",
1972 _ds->bDescriptorType);
1975 case USB_DT_INTERFACE: {
1976 struct usb_interface_descriptor *ds = (void *)_ds;
1977 pr_vdebug("interface descriptor\n");
1978 if (length != sizeof *ds)
1981 __entity(INTERFACE, ds->bInterfaceNumber);
1983 __entity(STRING, ds->iInterface);
1987 case USB_DT_ENDPOINT: {
1988 struct usb_endpoint_descriptor *ds = (void *)_ds;
1989 pr_vdebug("endpoint descriptor\n");
1990 if (length != USB_DT_ENDPOINT_SIZE &&
1991 length != USB_DT_ENDPOINT_AUDIO_SIZE)
1993 __entity(ENDPOINT, ds->bEndpointAddress);
1998 pr_vdebug("hid descriptor\n");
1999 if (length != sizeof(struct hid_descriptor))
2004 if (length != sizeof(struct usb_otg_descriptor))
2008 case USB_DT_INTERFACE_ASSOCIATION: {
2009 struct usb_interface_assoc_descriptor *ds = (void *)_ds;
2010 pr_vdebug("interface association descriptor\n");
2011 if (length != sizeof *ds)
2014 __entity(STRING, ds->iFunction);
2018 case USB_DT_SS_ENDPOINT_COMP:
2019 pr_vdebug("EP SS companion descriptor\n");
2020 if (length != sizeof(struct usb_ss_ep_comp_descriptor))
2024 case USB_DT_OTHER_SPEED_CONFIG:
2025 case USB_DT_INTERFACE_POWER:
2027 case USB_DT_SECURITY:
2028 case USB_DT_CS_RADIO_CONTROL:
2030 pr_vdebug("unimplemented descriptor: %d\n", _ds->bDescriptorType);
2034 /* We should never be here */
2035 pr_vdebug("unknown descriptor: %d\n", _ds->bDescriptorType);
2039 pr_vdebug("invalid length: %d (descriptor %d)\n",
2040 _ds->bLength, _ds->bDescriptorType);
2045 #undef __entity_check_DESCRIPTOR
2046 #undef __entity_check_INTERFACE
2047 #undef __entity_check_STRING
2048 #undef __entity_check_ENDPOINT
2053 static int __must_check ffs_do_descs(unsigned count, char *data, unsigned len,
2054 ffs_entity_callback entity, void *priv)
2056 const unsigned _len = len;
2057 unsigned long num = 0;
2067 /* Record "descriptor" entity */
2068 ret = entity(FFS_DESCRIPTOR, (u8 *)num, (void *)data, priv);
2069 if (unlikely(ret < 0)) {
2070 pr_debug("entity DESCRIPTOR(%02lx); ret = %d\n",
2078 ret = ffs_do_single_desc(data, len, entity, priv);
2079 if (unlikely(ret < 0)) {
2080 pr_debug("%s returns %d\n", __func__, ret);
2090 static int __ffs_data_do_entity(enum ffs_entity_type type,
2091 u8 *valuep, struct usb_descriptor_header *desc,
2094 struct ffs_desc_helper *helper = priv;
2095 struct usb_endpoint_descriptor *d;
2100 case FFS_DESCRIPTOR:
2105 * Interfaces are indexed from zero so if we
2106 * encountered interface "n" then there are at least
2109 if (*valuep >= helper->interfaces_count)
2110 helper->interfaces_count = *valuep + 1;
2115 * Strings are indexed from 1 (0 is reserved
2116 * for languages list)
2118 if (*valuep > helper->ffs->strings_count)
2119 helper->ffs->strings_count = *valuep;
2124 helper->eps_count++;
2125 if (helper->eps_count >= FFS_MAX_EPS_COUNT)
2127 /* Check if descriptors for any speed were already parsed */
2128 if (!helper->ffs->eps_count && !helper->ffs->interfaces_count)
2129 helper->ffs->eps_addrmap[helper->eps_count] =
2130 d->bEndpointAddress;
2131 else if (helper->ffs->eps_addrmap[helper->eps_count] !=
2132 d->bEndpointAddress)
2140 static int __ffs_do_os_desc_header(enum ffs_os_desc_type *next_type,
2141 struct usb_os_desc_header *desc)
2143 u16 bcd_version = le16_to_cpu(desc->bcdVersion);
2144 u16 w_index = le16_to_cpu(desc->wIndex);
2146 if (bcd_version != 1) {
2147 pr_vdebug("unsupported os descriptors version: %d",
2153 *next_type = FFS_OS_DESC_EXT_COMPAT;
2156 *next_type = FFS_OS_DESC_EXT_PROP;
2159 pr_vdebug("unsupported os descriptor type: %d", w_index);
2163 return sizeof(*desc);
2167 * Process all extended compatibility/extended property descriptors
2168 * of a feature descriptor
2170 static int __must_check ffs_do_single_os_desc(char *data, unsigned len,
2171 enum ffs_os_desc_type type,
2173 ffs_os_desc_callback entity,
2175 struct usb_os_desc_header *h)
2178 const unsigned _len = len;
2182 /* loop over all ext compat/ext prop descriptors */
2183 while (feature_count--) {
2184 ret = entity(type, h, data, len, priv);
2185 if (unlikely(ret < 0)) {
2186 pr_debug("bad OS descriptor, type: %d\n", type);
2195 /* Process a number of complete Feature Descriptors (Ext Compat or Ext Prop) */
2196 static int __must_check ffs_do_os_descs(unsigned count,
2197 char *data, unsigned len,
2198 ffs_os_desc_callback entity, void *priv)
2200 const unsigned _len = len;
2201 unsigned long num = 0;
2205 for (num = 0; num < count; ++num) {
2207 enum ffs_os_desc_type type;
2209 struct usb_os_desc_header *desc = (void *)data;
2211 if (len < sizeof(*desc))
2215 * Record "descriptor" entity.
2216 * Process dwLength, bcdVersion, wIndex, get b/wCount.
2217 * Move the data pointer to the beginning of extended
2218 * compatibilities proper or extended properties proper
2219 * portions of the data
2221 if (le32_to_cpu(desc->dwLength) > len)
2224 ret = __ffs_do_os_desc_header(&type, desc);
2225 if (unlikely(ret < 0)) {
2226 pr_debug("entity OS_DESCRIPTOR(%02lx); ret = %d\n",
2231 * 16-bit hex "?? 00" Little Endian looks like 8-bit hex "??"
2233 feature_count = le16_to_cpu(desc->wCount);
2234 if (type == FFS_OS_DESC_EXT_COMPAT &&
2235 (feature_count > 255 || desc->Reserved))
2241 * Process all function/property descriptors
2242 * of this Feature Descriptor
2244 ret = ffs_do_single_os_desc(data, len, type,
2245 feature_count, entity, priv, desc);
2246 if (unlikely(ret < 0)) {
2247 pr_debug("%s returns %d\n", __func__, ret);
2258 * Validate contents of the buffer from userspace related to OS descriptors.
2260 static int __ffs_data_do_os_desc(enum ffs_os_desc_type type,
2261 struct usb_os_desc_header *h, void *data,
2262 unsigned len, void *priv)
2264 struct ffs_data *ffs = priv;
2270 case FFS_OS_DESC_EXT_COMPAT: {
2271 struct usb_ext_compat_desc *d = data;
2274 if (len < sizeof(*d) ||
2275 d->bFirstInterfaceNumber >= ffs->interfaces_count)
2277 if (d->Reserved1 != 1) {
2279 * According to the spec, Reserved1 must be set to 1
2280 * but older kernels incorrectly rejected non-zero
2281 * values. We fix it here to avoid returning EINVAL
2282 * in response to values we used to accept.
2284 pr_debug("usb_ext_compat_desc::Reserved1 forced to 1\n");
2287 for (i = 0; i < ARRAY_SIZE(d->Reserved2); ++i)
2288 if (d->Reserved2[i])
2291 length = sizeof(struct usb_ext_compat_desc);
2294 case FFS_OS_DESC_EXT_PROP: {
2295 struct usb_ext_prop_desc *d = data;
2299 if (len < sizeof(*d) || h->interface >= ffs->interfaces_count)
2301 length = le32_to_cpu(d->dwSize);
2304 type = le32_to_cpu(d->dwPropertyDataType);
2305 if (type < USB_EXT_PROP_UNICODE ||
2306 type > USB_EXT_PROP_UNICODE_MULTI) {
2307 pr_vdebug("unsupported os descriptor property type: %d",
2311 pnl = le16_to_cpu(d->wPropertyNameLength);
2312 if (length < 14 + pnl) {
2313 pr_vdebug("invalid os descriptor length: %d pnl:%d (descriptor %d)\n",
2317 pdl = le32_to_cpu(*(u32 *)((u8 *)data + 10 + pnl));
2318 if (length != 14 + pnl + pdl) {
2319 pr_vdebug("invalid os descriptor length: %d pnl:%d pdl:%d (descriptor %d)\n",
2320 length, pnl, pdl, type);
2323 ++ffs->ms_os_descs_ext_prop_count;
2324 /* property name reported to the host as "WCHAR"s */
2325 ffs->ms_os_descs_ext_prop_name_len += pnl * 2;
2326 ffs->ms_os_descs_ext_prop_data_len += pdl;
2330 pr_vdebug("unknown descriptor: %d\n", type);
2336 static int __ffs_data_got_descs(struct ffs_data *ffs,
2337 char *const _data, size_t len)
2339 char *data = _data, *raw_descs;
2340 unsigned os_descs_count = 0, counts[3], flags;
2341 int ret = -EINVAL, i;
2342 struct ffs_desc_helper helper;
2346 if (get_unaligned_le32(data + 4) != len)
2349 switch (get_unaligned_le32(data)) {
2350 case FUNCTIONFS_DESCRIPTORS_MAGIC:
2351 flags = FUNCTIONFS_HAS_FS_DESC | FUNCTIONFS_HAS_HS_DESC;
2355 case FUNCTIONFS_DESCRIPTORS_MAGIC_V2:
2356 flags = get_unaligned_le32(data + 8);
2357 ffs->user_flags = flags;
2358 if (flags & ~(FUNCTIONFS_HAS_FS_DESC |
2359 FUNCTIONFS_HAS_HS_DESC |
2360 FUNCTIONFS_HAS_SS_DESC |
2361 FUNCTIONFS_HAS_MS_OS_DESC |
2362 FUNCTIONFS_VIRTUAL_ADDR |
2363 FUNCTIONFS_EVENTFD |
2364 FUNCTIONFS_ALL_CTRL_RECIP |
2365 FUNCTIONFS_CONFIG0_SETUP)) {
2376 if (flags & FUNCTIONFS_EVENTFD) {
2380 eventfd_ctx_fdget((int)get_unaligned_le32(data));
2381 if (IS_ERR(ffs->ffs_eventfd)) {
2382 ret = PTR_ERR(ffs->ffs_eventfd);
2383 ffs->ffs_eventfd = NULL;
2390 /* Read fs_count, hs_count and ss_count (if present) */
2391 for (i = 0; i < 3; ++i) {
2392 if (!(flags & (1 << i))) {
2394 } else if (len < 4) {
2397 counts[i] = get_unaligned_le32(data);
2402 if (flags & (1 << i)) {
2406 os_descs_count = get_unaligned_le32(data);
2411 /* Read descriptors */
2414 for (i = 0; i < 3; ++i) {
2417 helper.interfaces_count = 0;
2418 helper.eps_count = 0;
2419 ret = ffs_do_descs(counts[i], data, len,
2420 __ffs_data_do_entity, &helper);
2423 if (!ffs->eps_count && !ffs->interfaces_count) {
2424 ffs->eps_count = helper.eps_count;
2425 ffs->interfaces_count = helper.interfaces_count;
2427 if (ffs->eps_count != helper.eps_count) {
2431 if (ffs->interfaces_count != helper.interfaces_count) {
2439 if (os_descs_count) {
2440 ret = ffs_do_os_descs(os_descs_count, data, len,
2441 __ffs_data_do_os_desc, ffs);
2448 if (raw_descs == data || len) {
2453 ffs->raw_descs_data = _data;
2454 ffs->raw_descs = raw_descs;
2455 ffs->raw_descs_length = data - raw_descs;
2456 ffs->fs_descs_count = counts[0];
2457 ffs->hs_descs_count = counts[1];
2458 ffs->ss_descs_count = counts[2];
2459 ffs->ms_os_descs_count = os_descs_count;
2468 static int __ffs_data_got_strings(struct ffs_data *ffs,
2469 char *const _data, size_t len)
2471 u32 str_count, needed_count, lang_count;
2472 struct usb_gadget_strings **stringtabs, *t;
2473 const char *data = _data;
2474 struct usb_string *s;
2478 if (unlikely(len < 16 ||
2479 get_unaligned_le32(data) != FUNCTIONFS_STRINGS_MAGIC ||
2480 get_unaligned_le32(data + 4) != len))
2482 str_count = get_unaligned_le32(data + 8);
2483 lang_count = get_unaligned_le32(data + 12);
2485 /* if one is zero the other must be zero */
2486 if (unlikely(!str_count != !lang_count))
2489 /* Do we have at least as many strings as descriptors need? */
2490 needed_count = ffs->strings_count;
2491 if (unlikely(str_count < needed_count))
2495 * If we don't need any strings just return and free all
2498 if (!needed_count) {
2503 /* Allocate everything in one chunk so there's less maintenance. */
2507 vla_item(d, struct usb_gadget_strings *, stringtabs,
2509 vla_item(d, struct usb_gadget_strings, stringtab, lang_count);
2510 vla_item(d, struct usb_string, strings,
2511 lang_count*(needed_count+1));
2513 char *vlabuf = kmalloc(vla_group_size(d), GFP_KERNEL);
2515 if (unlikely(!vlabuf)) {
2520 /* Initialize the VLA pointers */
2521 stringtabs = vla_ptr(vlabuf, d, stringtabs);
2522 t = vla_ptr(vlabuf, d, stringtab);
2525 *stringtabs++ = t++;
2529 /* stringtabs = vlabuf = d_stringtabs for later kfree */
2530 stringtabs = vla_ptr(vlabuf, d, stringtabs);
2531 t = vla_ptr(vlabuf, d, stringtab);
2532 s = vla_ptr(vlabuf, d, strings);
2535 /* For each language */
2539 do { /* lang_count > 0 so we can use do-while */
2540 unsigned needed = needed_count;
2541 u32 str_per_lang = str_count;
2543 if (unlikely(len < 3))
2545 t->language = get_unaligned_le16(data);
2552 /* For each string */
2553 do { /* str_count > 0 so we can use do-while */
2554 size_t length = strnlen(data, len);
2556 if (unlikely(length == len))
2560 * User may provide more strings then we need,
2561 * if that's the case we simply ignore the
2564 if (likely(needed)) {
2566 * s->id will be set while adding
2567 * function to configuration so for
2568 * now just leave garbage here.
2577 } while (--str_per_lang);
2579 s->id = 0; /* terminator */
2583 } while (--lang_count);
2585 /* Some garbage left? */
2590 ffs->stringtabs = stringtabs;
2591 ffs->raw_strings = _data;
2603 /* Events handling and management *******************************************/
2605 static void __ffs_event_add(struct ffs_data *ffs,
2606 enum usb_functionfs_event_type type)
2608 enum usb_functionfs_event_type rem_type1, rem_type2 = type;
2612 * Abort any unhandled setup
2614 * We do not need to worry about some cmpxchg() changing value
2615 * of ffs->setup_state without holding the lock because when
2616 * state is FFS_SETUP_PENDING cmpxchg() in several places in
2617 * the source does nothing.
2619 if (ffs->setup_state == FFS_SETUP_PENDING)
2620 ffs->setup_state = FFS_SETUP_CANCELLED;
2623 * Logic of this function guarantees that there are at most four pending
2624 * evens on ffs->ev.types queue. This is important because the queue
2625 * has space for four elements only and __ffs_ep0_read_events function
2626 * depends on that limit as well. If more event types are added, those
2627 * limits have to be revisited or guaranteed to still hold.
2630 case FUNCTIONFS_RESUME:
2631 rem_type2 = FUNCTIONFS_SUSPEND;
2633 case FUNCTIONFS_SUSPEND:
2634 case FUNCTIONFS_SETUP:
2636 /* Discard all similar events */
2639 case FUNCTIONFS_BIND:
2640 case FUNCTIONFS_UNBIND:
2641 case FUNCTIONFS_DISABLE:
2642 case FUNCTIONFS_ENABLE:
2643 /* Discard everything other then power management. */
2644 rem_type1 = FUNCTIONFS_SUSPEND;
2645 rem_type2 = FUNCTIONFS_RESUME;
2650 WARN(1, "%d: unknown event, this should not happen\n", type);
2655 u8 *ev = ffs->ev.types, *out = ev;
2656 unsigned n = ffs->ev.count;
2657 for (; n; --n, ++ev)
2658 if ((*ev == rem_type1 || *ev == rem_type2) == neg)
2661 pr_vdebug("purging event %d\n", *ev);
2662 ffs->ev.count = out - ffs->ev.types;
2665 pr_vdebug("adding event %d\n", type);
2666 ffs->ev.types[ffs->ev.count++] = type;
2667 wake_up_locked(&ffs->ev.waitq);
2668 if (ffs->ffs_eventfd)
2669 eventfd_signal(ffs->ffs_eventfd, 1);
2672 static void ffs_event_add(struct ffs_data *ffs,
2673 enum usb_functionfs_event_type type)
2675 unsigned long flags;
2676 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
2677 __ffs_event_add(ffs, type);
2678 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
2681 /* Bind/unbind USB function hooks *******************************************/
2683 static int ffs_ep_addr2idx(struct ffs_data *ffs, u8 endpoint_address)
2687 for (i = 1; i < ARRAY_SIZE(ffs->eps_addrmap); ++i)
2688 if (ffs->eps_addrmap[i] == endpoint_address)
2693 static int __ffs_func_bind_do_descs(enum ffs_entity_type type, u8 *valuep,
2694 struct usb_descriptor_header *desc,
2697 struct usb_endpoint_descriptor *ds = (void *)desc;
2698 struct ffs_function *func = priv;
2699 struct ffs_ep *ffs_ep;
2700 unsigned ep_desc_id;
2702 static const char *speed_names[] = { "full", "high", "super" };
2704 if (type != FFS_DESCRIPTOR)
2708 * If ss_descriptors is not NULL, we are reading super speed
2709 * descriptors; if hs_descriptors is not NULL, we are reading high
2710 * speed descriptors; otherwise, we are reading full speed
2713 if (func->function.ss_descriptors) {
2715 func->function.ss_descriptors[(long)valuep] = desc;
2716 } else if (func->function.hs_descriptors) {
2718 func->function.hs_descriptors[(long)valuep] = desc;
2721 func->function.fs_descriptors[(long)valuep] = desc;
2724 if (!desc || desc->bDescriptorType != USB_DT_ENDPOINT)
2727 idx = ffs_ep_addr2idx(func->ffs, ds->bEndpointAddress) - 1;
2731 ffs_ep = func->eps + idx;
2733 if (unlikely(ffs_ep->descs[ep_desc_id])) {
2734 pr_err("two %sspeed descriptors for EP %d\n",
2735 speed_names[ep_desc_id],
2736 ds->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
2739 ffs_ep->descs[ep_desc_id] = ds;
2741 ffs_dump_mem(": Original ep desc", ds, ds->bLength);
2743 ds->bEndpointAddress = ffs_ep->descs[0]->bEndpointAddress;
2744 if (!ds->wMaxPacketSize)
2745 ds->wMaxPacketSize = ffs_ep->descs[0]->wMaxPacketSize;
2747 struct usb_request *req;
2749 u8 bEndpointAddress;
2752 * We back up bEndpointAddress because autoconfig overwrites
2753 * it with physical endpoint address.
2755 bEndpointAddress = ds->bEndpointAddress;
2756 pr_vdebug("autoconfig\n");
2757 ep = usb_ep_autoconfig(func->gadget, ds);
2760 ep->driver_data = func->eps + idx;
2762 req = usb_ep_alloc_request(ep, GFP_KERNEL);
2768 func->eps_revmap[ds->bEndpointAddress &
2769 USB_ENDPOINT_NUMBER_MASK] = idx + 1;
2771 * If we use virtual address mapping, we restore
2772 * original bEndpointAddress value.
2774 if (func->ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
2775 ds->bEndpointAddress = bEndpointAddress;
2777 ffs_dump_mem(": Rewritten ep desc", ds, ds->bLength);
2782 static int __ffs_func_bind_do_nums(enum ffs_entity_type type, u8 *valuep,
2783 struct usb_descriptor_header *desc,
2786 struct ffs_function *func = priv;
2792 case FFS_DESCRIPTOR:
2793 /* Handled in previous pass by __ffs_func_bind_do_descs() */
2798 if (func->interfaces_nums[idx] < 0) {
2799 int id = usb_interface_id(func->conf, &func->function);
2800 if (unlikely(id < 0))
2802 func->interfaces_nums[idx] = id;
2804 newValue = func->interfaces_nums[idx];
2808 /* String' IDs are allocated when fsf_data is bound to cdev */
2809 newValue = func->ffs->stringtabs[0]->strings[*valuep - 1].id;
2814 * USB_DT_ENDPOINT are handled in
2815 * __ffs_func_bind_do_descs().
2817 if (desc->bDescriptorType == USB_DT_ENDPOINT)
2820 idx = (*valuep & USB_ENDPOINT_NUMBER_MASK) - 1;
2821 if (unlikely(!func->eps[idx].ep))
2825 struct usb_endpoint_descriptor **descs;
2826 descs = func->eps[idx].descs;
2827 newValue = descs[descs[0] ? 0 : 1]->bEndpointAddress;
2832 pr_vdebug("%02x -> %02x\n", *valuep, newValue);
2837 static int __ffs_func_bind_do_os_desc(enum ffs_os_desc_type type,
2838 struct usb_os_desc_header *h, void *data,
2839 unsigned len, void *priv)
2841 struct ffs_function *func = priv;
2845 case FFS_OS_DESC_EXT_COMPAT: {
2846 struct usb_ext_compat_desc *desc = data;
2847 struct usb_os_desc_table *t;
2849 t = &func->function.os_desc_table[desc->bFirstInterfaceNumber];
2850 t->if_id = func->interfaces_nums[desc->bFirstInterfaceNumber];
2851 memcpy(t->os_desc->ext_compat_id, &desc->CompatibleID,
2852 ARRAY_SIZE(desc->CompatibleID) +
2853 ARRAY_SIZE(desc->SubCompatibleID));
2854 length = sizeof(*desc);
2857 case FFS_OS_DESC_EXT_PROP: {
2858 struct usb_ext_prop_desc *desc = data;
2859 struct usb_os_desc_table *t;
2860 struct usb_os_desc_ext_prop *ext_prop;
2861 char *ext_prop_name;
2862 char *ext_prop_data;
2864 t = &func->function.os_desc_table[h->interface];
2865 t->if_id = func->interfaces_nums[h->interface];
2867 ext_prop = func->ffs->ms_os_descs_ext_prop_avail;
2868 func->ffs->ms_os_descs_ext_prop_avail += sizeof(*ext_prop);
2870 ext_prop->type = le32_to_cpu(desc->dwPropertyDataType);
2871 ext_prop->name_len = le16_to_cpu(desc->wPropertyNameLength);
2872 ext_prop->data_len = le32_to_cpu(*(u32 *)
2873 usb_ext_prop_data_len_ptr(data, ext_prop->name_len));
2874 length = ext_prop->name_len + ext_prop->data_len + 14;
2876 ext_prop_name = func->ffs->ms_os_descs_ext_prop_name_avail;
2877 func->ffs->ms_os_descs_ext_prop_name_avail +=
2880 ext_prop_data = func->ffs->ms_os_descs_ext_prop_data_avail;
2881 func->ffs->ms_os_descs_ext_prop_data_avail +=
2883 memcpy(ext_prop_data,
2884 usb_ext_prop_data_ptr(data, ext_prop->name_len),
2885 ext_prop->data_len);
2886 /* unicode data reported to the host as "WCHAR"s */
2887 switch (ext_prop->type) {
2888 case USB_EXT_PROP_UNICODE:
2889 case USB_EXT_PROP_UNICODE_ENV:
2890 case USB_EXT_PROP_UNICODE_LINK:
2891 case USB_EXT_PROP_UNICODE_MULTI:
2892 ext_prop->data_len *= 2;
2895 ext_prop->data = ext_prop_data;
2897 memcpy(ext_prop_name, usb_ext_prop_name_ptr(data),
2898 ext_prop->name_len);
2899 /* property name reported to the host as "WCHAR"s */
2900 ext_prop->name_len *= 2;
2901 ext_prop->name = ext_prop_name;
2903 t->os_desc->ext_prop_len +=
2904 ext_prop->name_len + ext_prop->data_len + 14;
2905 ++t->os_desc->ext_prop_count;
2906 list_add_tail(&ext_prop->entry, &t->os_desc->ext_prop);
2910 pr_vdebug("unknown descriptor: %d\n", type);
2916 static inline struct f_fs_opts *ffs_do_functionfs_bind(struct usb_function *f,
2917 struct usb_configuration *c)
2919 struct ffs_function *func = ffs_func_from_usb(f);
2920 struct f_fs_opts *ffs_opts =
2921 container_of(f->fi, struct f_fs_opts, func_inst);
2922 struct ffs_data *ffs_data;
2928 * Legacy gadget triggers binding in functionfs_ready_callback,
2929 * which already uses locking; taking the same lock here would
2932 * Configfs-enabled gadgets however do need ffs_dev_lock.
2934 if (!ffs_opts->no_configfs)
2936 ret = ffs_opts->dev->desc_ready ? 0 : -ENODEV;
2937 ffs_data = ffs_opts->dev->ffs_data;
2938 if (!ffs_opts->no_configfs)
2941 return ERR_PTR(ret);
2943 func->ffs = ffs_data;
2945 func->gadget = c->cdev->gadget;
2948 * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
2949 * configurations are bound in sequence with list_for_each_entry,
2950 * in each configuration its functions are bound in sequence
2951 * with list_for_each_entry, so we assume no race condition
2952 * with regard to ffs_opts->bound access
2954 if (!ffs_opts->refcnt) {
2955 ret = functionfs_bind(func->ffs, c->cdev);
2957 return ERR_PTR(ret);
2960 func->function.strings = func->ffs->stringtabs;
2965 static int _ffs_func_bind(struct usb_configuration *c,
2966 struct usb_function *f)
2968 struct ffs_function *func = ffs_func_from_usb(f);
2969 struct ffs_data *ffs = func->ffs;
2971 const int full = !!func->ffs->fs_descs_count;
2972 const int high = !!func->ffs->hs_descs_count;
2973 const int super = !!func->ffs->ss_descs_count;
2975 int fs_len, hs_len, ss_len, ret, i;
2976 struct ffs_ep *eps_ptr;
2978 /* Make it a single chunk, less management later on */
2980 vla_item_with_sz(d, struct ffs_ep, eps, ffs->eps_count);
2981 vla_item_with_sz(d, struct usb_descriptor_header *, fs_descs,
2982 full ? ffs->fs_descs_count + 1 : 0);
2983 vla_item_with_sz(d, struct usb_descriptor_header *, hs_descs,
2984 high ? ffs->hs_descs_count + 1 : 0);
2985 vla_item_with_sz(d, struct usb_descriptor_header *, ss_descs,
2986 super ? ffs->ss_descs_count + 1 : 0);
2987 vla_item_with_sz(d, short, inums, ffs->interfaces_count);
2988 vla_item_with_sz(d, struct usb_os_desc_table, os_desc_table,
2989 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2990 vla_item_with_sz(d, char[16], ext_compat,
2991 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2992 vla_item_with_sz(d, struct usb_os_desc, os_desc,
2993 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2994 vla_item_with_sz(d, struct usb_os_desc_ext_prop, ext_prop,
2995 ffs->ms_os_descs_ext_prop_count);
2996 vla_item_with_sz(d, char, ext_prop_name,
2997 ffs->ms_os_descs_ext_prop_name_len);
2998 vla_item_with_sz(d, char, ext_prop_data,
2999 ffs->ms_os_descs_ext_prop_data_len);
3000 vla_item_with_sz(d, char, raw_descs, ffs->raw_descs_length);
3005 /* Has descriptors only for speeds gadget does not support */
3006 if (unlikely(!(full | high | super)))
3009 /* Allocate a single chunk, less management later on */
3010 vlabuf = kzalloc(vla_group_size(d), GFP_KERNEL);
3011 if (unlikely(!vlabuf))
3014 ffs->ms_os_descs_ext_prop_avail = vla_ptr(vlabuf, d, ext_prop);
3015 ffs->ms_os_descs_ext_prop_name_avail =
3016 vla_ptr(vlabuf, d, ext_prop_name);
3017 ffs->ms_os_descs_ext_prop_data_avail =
3018 vla_ptr(vlabuf, d, ext_prop_data);
3020 /* Copy descriptors */
3021 memcpy(vla_ptr(vlabuf, d, raw_descs), ffs->raw_descs,
3022 ffs->raw_descs_length);
3024 memset(vla_ptr(vlabuf, d, inums), 0xff, d_inums__sz);
3025 eps_ptr = vla_ptr(vlabuf, d, eps);
3026 for (i = 0; i < ffs->eps_count; i++)
3027 eps_ptr[i].num = -1;
3030 * d_eps == vlabuf, func->eps used to kfree vlabuf later
3032 func->eps = vla_ptr(vlabuf, d, eps);
3033 func->interfaces_nums = vla_ptr(vlabuf, d, inums);
3036 * Go through all the endpoint descriptors and allocate
3037 * endpoints first, so that later we can rewrite the endpoint
3038 * numbers without worrying that it may be described later on.
3041 func->function.fs_descriptors = vla_ptr(vlabuf, d, fs_descs);
3042 fs_len = ffs_do_descs(ffs->fs_descs_count,
3043 vla_ptr(vlabuf, d, raw_descs),
3045 __ffs_func_bind_do_descs, func);
3046 if (unlikely(fs_len < 0)) {
3055 func->function.hs_descriptors = vla_ptr(vlabuf, d, hs_descs);
3056 hs_len = ffs_do_descs(ffs->hs_descs_count,
3057 vla_ptr(vlabuf, d, raw_descs) + fs_len,
3058 d_raw_descs__sz - fs_len,
3059 __ffs_func_bind_do_descs, func);
3060 if (unlikely(hs_len < 0)) {
3068 if (likely(super)) {
3069 func->function.ss_descriptors = func->function.ssp_descriptors =
3070 vla_ptr(vlabuf, d, ss_descs);
3071 ss_len = ffs_do_descs(ffs->ss_descs_count,
3072 vla_ptr(vlabuf, d, raw_descs) + fs_len + hs_len,
3073 d_raw_descs__sz - fs_len - hs_len,
3074 __ffs_func_bind_do_descs, func);
3075 if (unlikely(ss_len < 0)) {
3084 * Now handle interface numbers allocation and interface and
3085 * endpoint numbers rewriting. We can do that in one go
3088 ret = ffs_do_descs(ffs->fs_descs_count +
3089 (high ? ffs->hs_descs_count : 0) +
3090 (super ? ffs->ss_descs_count : 0),
3091 vla_ptr(vlabuf, d, raw_descs), d_raw_descs__sz,
3092 __ffs_func_bind_do_nums, func);
3093 if (unlikely(ret < 0))
3096 func->function.os_desc_table = vla_ptr(vlabuf, d, os_desc_table);
3097 if (c->cdev->use_os_string) {
3098 for (i = 0; i < ffs->interfaces_count; ++i) {
3099 struct usb_os_desc *desc;
3101 desc = func->function.os_desc_table[i].os_desc =
3102 vla_ptr(vlabuf, d, os_desc) +
3103 i * sizeof(struct usb_os_desc);
3104 desc->ext_compat_id =
3105 vla_ptr(vlabuf, d, ext_compat) + i * 16;
3106 INIT_LIST_HEAD(&desc->ext_prop);
3108 ret = ffs_do_os_descs(ffs->ms_os_descs_count,
3109 vla_ptr(vlabuf, d, raw_descs) +
3110 fs_len + hs_len + ss_len,
3111 d_raw_descs__sz - fs_len - hs_len -
3113 __ffs_func_bind_do_os_desc, func);
3114 if (unlikely(ret < 0))
3117 func->function.os_desc_n =
3118 c->cdev->use_os_string ? ffs->interfaces_count : 0;
3120 /* And we're done */
3121 ffs_event_add(ffs, FUNCTIONFS_BIND);
3125 /* XXX Do we need to release all claimed endpoints here? */
3129 static int ffs_func_bind(struct usb_configuration *c,
3130 struct usb_function *f)
3132 struct f_fs_opts *ffs_opts = ffs_do_functionfs_bind(f, c);
3133 struct ffs_function *func = ffs_func_from_usb(f);
3136 if (IS_ERR(ffs_opts))
3137 return PTR_ERR(ffs_opts);
3139 ret = _ffs_func_bind(c, f);
3140 if (ret && !--ffs_opts->refcnt)
3141 functionfs_unbind(func->ffs);
3147 /* Other USB function hooks *************************************************/
3149 static void ffs_reset_work(struct work_struct *work)
3151 struct ffs_data *ffs = container_of(work,
3152 struct ffs_data, reset_work);
3153 ffs_data_reset(ffs);
3156 static int ffs_func_set_alt(struct usb_function *f,
3157 unsigned interface, unsigned alt)
3159 struct ffs_function *func = ffs_func_from_usb(f);
3160 struct ffs_data *ffs = func->ffs;
3163 if (alt != (unsigned)-1) {
3164 intf = ffs_func_revmap_intf(func, interface);
3165 if (unlikely(intf < 0))
3170 ffs_func_eps_disable(ffs->func);
3172 if (ffs->state == FFS_DEACTIVATED) {
3173 ffs->state = FFS_CLOSING;
3174 INIT_WORK(&ffs->reset_work, ffs_reset_work);
3175 schedule_work(&ffs->reset_work);
3179 if (ffs->state != FFS_ACTIVE)
3182 if (alt == (unsigned)-1) {
3184 ffs_event_add(ffs, FUNCTIONFS_DISABLE);
3189 ret = ffs_func_eps_enable(func);
3190 if (likely(ret >= 0))
3191 ffs_event_add(ffs, FUNCTIONFS_ENABLE);
3195 static void ffs_func_disable(struct usb_function *f)
3197 ffs_func_set_alt(f, 0, (unsigned)-1);
3200 static int ffs_func_setup(struct usb_function *f,
3201 const struct usb_ctrlrequest *creq)
3203 struct ffs_function *func = ffs_func_from_usb(f);
3204 struct ffs_data *ffs = func->ffs;
3205 unsigned long flags;
3210 pr_vdebug("creq->bRequestType = %02x\n", creq->bRequestType);
3211 pr_vdebug("creq->bRequest = %02x\n", creq->bRequest);
3212 pr_vdebug("creq->wValue = %04x\n", le16_to_cpu(creq->wValue));
3213 pr_vdebug("creq->wIndex = %04x\n", le16_to_cpu(creq->wIndex));
3214 pr_vdebug("creq->wLength = %04x\n", le16_to_cpu(creq->wLength));
3217 * Most requests directed to interface go through here
3218 * (notable exceptions are set/get interface) so we need to
3219 * handle them. All other either handled by composite or
3220 * passed to usb_configuration->setup() (if one is set). No
3221 * matter, we will handle requests directed to endpoint here
3222 * as well (as it's straightforward). Other request recipient
3223 * types are only handled when the user flag FUNCTIONFS_ALL_CTRL_RECIP
3226 if (ffs->state != FFS_ACTIVE)
3229 switch (creq->bRequestType & USB_RECIP_MASK) {
3230 case USB_RECIP_INTERFACE:
3231 ret = ffs_func_revmap_intf(func, le16_to_cpu(creq->wIndex));
3232 if (unlikely(ret < 0))
3236 case USB_RECIP_ENDPOINT:
3237 ret = ffs_func_revmap_ep(func, le16_to_cpu(creq->wIndex));
3238 if (unlikely(ret < 0))
3240 if (func->ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
3241 ret = func->ffs->eps_addrmap[ret];
3245 if (func->ffs->user_flags & FUNCTIONFS_ALL_CTRL_RECIP)
3246 ret = le16_to_cpu(creq->wIndex);
3251 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
3252 ffs->ev.setup = *creq;
3253 ffs->ev.setup.wIndex = cpu_to_le16(ret);
3254 __ffs_event_add(ffs, FUNCTIONFS_SETUP);
3255 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
3257 return creq->wLength == 0 ? USB_GADGET_DELAYED_STATUS : 0;
3260 static bool ffs_func_req_match(struct usb_function *f,
3261 const struct usb_ctrlrequest *creq,
3264 struct ffs_function *func = ffs_func_from_usb(f);
3266 if (config0 && !(func->ffs->user_flags & FUNCTIONFS_CONFIG0_SETUP))
3269 switch (creq->bRequestType & USB_RECIP_MASK) {
3270 case USB_RECIP_INTERFACE:
3271 return (ffs_func_revmap_intf(func,
3272 le16_to_cpu(creq->wIndex)) >= 0);
3273 case USB_RECIP_ENDPOINT:
3274 return (ffs_func_revmap_ep(func,
3275 le16_to_cpu(creq->wIndex)) >= 0);
3277 return (bool) (func->ffs->user_flags &
3278 FUNCTIONFS_ALL_CTRL_RECIP);
3282 static void ffs_func_suspend(struct usb_function *f)
3285 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_SUSPEND);
3288 static void ffs_func_resume(struct usb_function *f)
3291 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_RESUME);
3295 /* Endpoint and interface numbers reverse mapping ***************************/
3297 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num)
3299 num = func->eps_revmap[num & USB_ENDPOINT_NUMBER_MASK];
3300 return num ? num : -EDOM;
3303 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf)
3305 short *nums = func->interfaces_nums;
3306 unsigned count = func->ffs->interfaces_count;
3308 for (; count; --count, ++nums) {
3309 if (*nums >= 0 && *nums == intf)
3310 return nums - func->interfaces_nums;
3317 /* Devices management *******************************************************/
3319 static LIST_HEAD(ffs_devices);
3321 static struct ffs_dev *_ffs_do_find_dev(const char *name)
3323 struct ffs_dev *dev;
3328 list_for_each_entry(dev, &ffs_devices, entry) {
3329 if (strcmp(dev->name, name) == 0)
3337 * ffs_lock must be taken by the caller of this function
3339 static struct ffs_dev *_ffs_get_single_dev(void)
3341 struct ffs_dev *dev;
3343 if (list_is_singular(&ffs_devices)) {
3344 dev = list_first_entry(&ffs_devices, struct ffs_dev, entry);
3353 * ffs_lock must be taken by the caller of this function
3355 static struct ffs_dev *_ffs_find_dev(const char *name)
3357 struct ffs_dev *dev;
3359 dev = _ffs_get_single_dev();
3363 return _ffs_do_find_dev(name);
3366 /* Configfs support *********************************************************/
3368 static inline struct f_fs_opts *to_ffs_opts(struct config_item *item)
3370 return container_of(to_config_group(item), struct f_fs_opts,
3374 static void ffs_attr_release(struct config_item *item)
3376 struct f_fs_opts *opts = to_ffs_opts(item);
3378 usb_put_function_instance(&opts->func_inst);
3381 static struct configfs_item_operations ffs_item_ops = {
3382 .release = ffs_attr_release,
3385 static struct config_item_type ffs_func_type = {
3386 .ct_item_ops = &ffs_item_ops,
3387 .ct_owner = THIS_MODULE,
3391 /* Function registration interface ******************************************/
3393 static void ffs_free_inst(struct usb_function_instance *f)
3395 struct f_fs_opts *opts;
3397 opts = to_f_fs_opts(f);
3398 ffs_release_dev(opts->dev);
3400 _ffs_free_dev(opts->dev);
3405 static int ffs_set_inst_name(struct usb_function_instance *fi, const char *name)
3407 if (strlen(name) >= FIELD_SIZEOF(struct ffs_dev, name))
3408 return -ENAMETOOLONG;
3409 return ffs_name_dev(to_f_fs_opts(fi)->dev, name);
3412 static struct usb_function_instance *ffs_alloc_inst(void)
3414 struct f_fs_opts *opts;
3415 struct ffs_dev *dev;
3417 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3419 return ERR_PTR(-ENOMEM);
3421 opts->func_inst.set_inst_name = ffs_set_inst_name;
3422 opts->func_inst.free_func_inst = ffs_free_inst;
3424 dev = _ffs_alloc_dev();
3428 return ERR_CAST(dev);
3433 config_group_init_type_name(&opts->func_inst.group, "",
3435 return &opts->func_inst;
3438 static void ffs_free(struct usb_function *f)
3440 kfree(ffs_func_from_usb(f));
3443 static void ffs_func_unbind(struct usb_configuration *c,
3444 struct usb_function *f)
3446 struct ffs_function *func = ffs_func_from_usb(f);
3447 struct ffs_data *ffs = func->ffs;
3448 struct f_fs_opts *opts =
3449 container_of(f->fi, struct f_fs_opts, func_inst);
3450 struct ffs_ep *ep = func->eps;
3451 unsigned count = ffs->eps_count;
3452 unsigned long flags;
3455 if (ffs->func == func) {
3456 ffs_func_eps_disable(func);
3460 /* Drain any pending AIO completions */
3461 drain_workqueue(ffs->io_completion_wq);
3463 if (!--opts->refcnt)
3464 functionfs_unbind(ffs);
3466 /* cleanup after autoconfig */
3467 spin_lock_irqsave(&func->ffs->eps_lock, flags);
3469 if (ep->ep && ep->req)
3470 usb_ep_free_request(ep->ep, ep->req);
3474 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
3478 * eps, descriptors and interfaces_nums are allocated in the
3479 * same chunk so only one free is required.
3481 func->function.fs_descriptors = NULL;
3482 func->function.hs_descriptors = NULL;
3483 func->function.ss_descriptors = NULL;
3484 func->function.ssp_descriptors = NULL;
3485 func->interfaces_nums = NULL;
3487 ffs_event_add(ffs, FUNCTIONFS_UNBIND);
3490 static struct usb_function *ffs_alloc(struct usb_function_instance *fi)
3492 struct ffs_function *func;
3496 func = kzalloc(sizeof(*func), GFP_KERNEL);
3497 if (unlikely(!func))
3498 return ERR_PTR(-ENOMEM);
3500 func->function.name = "Function FS Gadget";
3502 func->function.bind = ffs_func_bind;
3503 func->function.unbind = ffs_func_unbind;
3504 func->function.set_alt = ffs_func_set_alt;
3505 func->function.disable = ffs_func_disable;
3506 func->function.setup = ffs_func_setup;
3507 func->function.req_match = ffs_func_req_match;
3508 func->function.suspend = ffs_func_suspend;
3509 func->function.resume = ffs_func_resume;
3510 func->function.free_func = ffs_free;
3512 return &func->function;
3516 * ffs_lock must be taken by the caller of this function
3518 static struct ffs_dev *_ffs_alloc_dev(void)
3520 struct ffs_dev *dev;
3523 if (_ffs_get_single_dev())
3524 return ERR_PTR(-EBUSY);
3526 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3528 return ERR_PTR(-ENOMEM);
3530 if (list_empty(&ffs_devices)) {
3531 ret = functionfs_init();
3534 return ERR_PTR(ret);
3538 list_add(&dev->entry, &ffs_devices);
3543 int ffs_name_dev(struct ffs_dev *dev, const char *name)
3545 struct ffs_dev *existing;
3550 existing = _ffs_do_find_dev(name);
3552 strlcpy(dev->name, name, ARRAY_SIZE(dev->name));
3553 else if (existing != dev)
3560 EXPORT_SYMBOL_GPL(ffs_name_dev);
3562 int ffs_single_dev(struct ffs_dev *dev)
3569 if (!list_is_singular(&ffs_devices))
3577 EXPORT_SYMBOL_GPL(ffs_single_dev);
3580 * ffs_lock must be taken by the caller of this function
3582 static void _ffs_free_dev(struct ffs_dev *dev)
3584 list_del(&dev->entry);
3587 if (list_empty(&ffs_devices))
3588 functionfs_cleanup();
3591 static int ffs_acquire_dev(const char *dev_name, struct ffs_data *ffs_data)
3594 struct ffs_dev *ffs_dev;
3599 ffs_dev = _ffs_find_dev(dev_name);
3602 } else if (ffs_dev->mounted) {
3604 } else if (ffs_dev->ffs_acquire_dev_callback &&
3605 ffs_dev->ffs_acquire_dev_callback(ffs_dev)) {
3608 ffs_dev->mounted = true;
3609 ffs_dev->ffs_data = ffs_data;
3610 ffs_data->private_data = ffs_dev;
3617 static void ffs_release_dev(struct ffs_dev *ffs_dev)
3622 if (ffs_dev && ffs_dev->mounted) {
3623 ffs_dev->mounted = false;
3624 if (ffs_dev->ffs_data) {
3625 ffs_dev->ffs_data->private_data = NULL;
3626 ffs_dev->ffs_data = NULL;
3629 if (ffs_dev->ffs_release_dev_callback)
3630 ffs_dev->ffs_release_dev_callback(ffs_dev);
3636 static int ffs_ready(struct ffs_data *ffs)
3638 struct ffs_dev *ffs_obj;
3644 ffs_obj = ffs->private_data;
3649 if (WARN_ON(ffs_obj->desc_ready)) {
3654 ffs_obj->desc_ready = true;
3656 if (ffs_obj->ffs_ready_callback) {
3657 ret = ffs_obj->ffs_ready_callback(ffs);
3662 set_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags);
3668 static void ffs_closed(struct ffs_data *ffs)
3670 struct ffs_dev *ffs_obj;
3671 struct f_fs_opts *opts;
3672 struct config_item *ci;
3677 ffs_obj = ffs->private_data;
3681 ffs_obj->desc_ready = false;
3683 if (test_and_clear_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags) &&
3684 ffs_obj->ffs_closed_callback)
3685 ffs_obj->ffs_closed_callback(ffs);
3688 opts = ffs_obj->opts;
3692 if (opts->no_configfs || !opts->func_inst.group.cg_item.ci_parent
3693 || !kref_read(&opts->func_inst.group.cg_item.ci_kref))
3696 ci = opts->func_inst.group.cg_item.ci_parent->ci_parent;
3699 if (test_bit(FFS_FL_BOUND, &ffs->flags))
3700 unregister_gadget_item(ci);
3706 /* Misc helper functions ****************************************************/
3708 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
3711 ? likely(mutex_trylock(mutex)) ? 0 : -EAGAIN
3712 : mutex_lock_interruptible(mutex);
3715 static char *ffs_prepare_buffer(const char __user *buf, size_t len)
3722 data = kmalloc(len, GFP_KERNEL);
3723 if (unlikely(!data))
3724 return ERR_PTR(-ENOMEM);
3726 if (unlikely(copy_from_user(data, buf, len))) {
3728 return ERR_PTR(-EFAULT);
3731 pr_vdebug("Buffer from user space:\n");
3732 ffs_dump_mem("", data, len);
3737 DECLARE_USB_FUNCTION_INIT(ffs, ffs_alloc_inst, ffs_alloc);
3738 MODULE_LICENSE("GPL");
3739 MODULE_AUTHOR("Michal Nazarewicz");