2 * f_fs.c -- user mode filesystem api for usb composite funtcion controllers
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <m.nazarewicz@samsung.com>
7 * Based on inode.c (GadgetFS):
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.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 /* #define VERBOSE_DEBUG */
30 #include <linux/blkdev.h>
31 #include <linux/pagemap.h>
32 #include <asm/unaligned.h>
33 #include <linux/smp_lock.h>
35 #include <linux/usb/composite.h>
36 #include <linux/usb/functionfs.h>
39 #define FUNCTIONFS_MAGIC 0xa647361 /* Chosen by a honest dice roll ;) */
42 /* Debuging *****************************************************************/
44 #define ffs_printk(level, fmt, args...) printk(level "f_fs: " fmt "\n", ## args)
46 #define FERR(...) ffs_printk(KERN_ERR, __VA_ARGS__)
47 #define FINFO(...) ffs_printk(KERN_INFO, __VA_ARGS__)
50 # define FDBG(...) ffs_printk(KERN_DEBUG, __VA_ARGS__)
52 # define FDBG(...) do { } while (0)
58 # define FVDBG(...) do { } while (0)
59 #endif /* VERBOSE_DEBUG */
61 #define ENTER() FVDBG("%s()", __func__)
64 # define ffs_dump_mem(prefix, ptr, len) \
65 print_hex_dump_bytes("f_fs" prefix ": ", DUMP_PREFIX_NONE, ptr, len)
67 # define ffs_dump_mem(prefix, ptr, len) do { } while (0)
71 /* The data structure and setup file ****************************************/
74 /* Waiting for descriptors and strings. */
75 /* In this state no open(2), read(2) or write(2) on epfiles
76 * may succeed (which should not be the problem as there
77 * should be no such files opened in the firts place). */
81 /* We've got descriptors and strings. We are or have called
82 * functionfs_ready_callback(). functionfs_bind() may have
83 * been called but we don't know. */
84 /* This is the only state in which operations on epfiles may
88 /* All endpoints have been closed. This state is also set if
89 * we encounter an unrecoverable error. The only
90 * unrecoverable error is situation when after reading strings
91 * from user space we fail to initialise EP files or
92 * functionfs_ready_callback() returns with error (<0). */
93 /* In this state no open(2), read(2) or write(2) (both on ep0
94 * as well as epfile) may succeed (at this point epfiles are
95 * unlinked and all closed so this is not a problem; ep0 is
96 * also closed but ep0 file exists and so open(2) on ep0 must
102 enum ffs_setup_state {
103 /* There is no setup request pending. */
105 /* User has read events and there was a setup request event
106 * there. The next read/write on ep0 will handle the
109 /* There was event pending but before user space handled it
110 * some other event was introduced which canceled existing
111 * setup. If this state is set read/write on ep0 return
112 * -EIDRM. This state is only set when adding event. */
122 struct usb_gadget *gadget;
124 /* Protect access read/write operations, only one read/write
125 * at a time. As a consequence protects ep0req and company.
126 * While setup request is being processed (queued) this is
130 /* Protect access to enpoint related structures (basically
131 * usb_ep_queue(), usb_ep_dequeue(), etc. calls) except for
135 /* XXX REVISIT do we need our own request? Since we are not
136 * handling setup requests immidiatelly user space may be so
137 * slow that another setup will be sent to the gadget but this
138 * time not to us but another function and then there could be
139 * a race. Is that the case? Or maybe we can use cdev->req
140 * after all, maybe we just need some spinlock for that? */
141 struct usb_request *ep0req; /* P: mutex */
142 struct completion ep0req_completion; /* P: mutex */
143 int ep0req_status; /* P: mutex */
145 /* reference counter */
147 /* how many files are opened (EP0 and others) */
151 enum ffs_state state;
154 * Possible transations:
155 * + FFS_NO_SETUP -> FFS_SETUP_PENDING -- P: ev.waitq.lock
156 * happens only in ep0 read which is P: mutex
157 * + FFS_SETUP_PENDING -> FFS_NO_SETUP -- P: ev.waitq.lock
158 * happens only in ep0 i/o which is P: mutex
159 * + FFS_SETUP_PENDING -> FFS_SETUP_CANCELED -- P: ev.waitq.lock
160 * + FFS_SETUP_CANCELED -> FFS_NO_SETUP -- cmpxchg
162 enum ffs_setup_state setup_state;
164 #define FFS_SETUP_STATE(ffs) \
165 ((enum ffs_setup_state)cmpxchg(&(ffs)->setup_state, \
166 FFS_SETUP_CANCELED, FFS_NO_SETUP))
171 unsigned short count;
172 /* XXX REVISIT need to update it in some places, or do we? */
173 unsigned short can_stall;
174 struct usb_ctrlrequest setup;
176 wait_queue_head_t waitq;
177 } ev; /* the whole structure, P: ev.waitq.lock */
181 #define FFS_FL_CALL_CLOSED_CALLBACK 0
182 #define FFS_FL_BOUND 1
184 /* Active function */
185 struct ffs_function *func;
187 /* Device name, write once when file system is mounted.
188 * Intendet for user to read if she wants. */
189 const char *dev_name;
190 /* Private data for our user (ie. gadget). Managed by
194 /* filled by __ffs_data_got_descs() */
195 /* real descriptors are 16 bytes after raw_descs (so you need
196 * to skip 16 bytes (ie. ffs->raw_descs + 16) to get to the
197 * first full speed descriptor). raw_descs_length and
198 * raw_fs_descs_length do not have those 16 bytes added. */
199 const void *raw_descs;
200 unsigned raw_descs_length;
201 unsigned raw_fs_descs_length;
202 unsigned fs_descs_count;
203 unsigned hs_descs_count;
205 unsigned short strings_count;
206 unsigned short interfaces_count;
207 unsigned short eps_count;
208 unsigned short _pad1;
210 /* filled by __ffs_data_got_strings() */
211 /* ids in stringtabs are set in functionfs_bind() */
212 const void *raw_strings;
213 struct usb_gadget_strings **stringtabs;
215 /* File system's super block, write once when file system is mounted. */
216 struct super_block *sb;
218 /* File permissions, written once when fs is mounted*/
219 struct ffs_file_perms {
225 /* The endpoint files, filled by ffs_epfiles_create(),
226 * destroyed by ffs_epfiles_destroy(). */
227 struct ffs_epfile *epfiles;
230 /* Reference counter handling */
231 static void ffs_data_get(struct ffs_data *ffs);
232 static void ffs_data_put(struct ffs_data *ffs);
233 /* Creates new ffs_data object. */
234 static struct ffs_data *__must_check ffs_data_new(void) __attribute__((malloc));
236 /* Opened counter handling. */
237 static void ffs_data_opened(struct ffs_data *ffs);
238 static void ffs_data_closed(struct ffs_data *ffs);
240 /* Called with ffs->mutex held; take over ownerrship of data. */
241 static int __must_check
242 __ffs_data_got_descs(struct ffs_data *ffs, char *data, size_t len);
243 static int __must_check
244 __ffs_data_got_strings(struct ffs_data *ffs, char *data, size_t len);
247 /* The function structure ***************************************************/
251 struct ffs_function {
252 struct usb_configuration *conf;
253 struct usb_gadget *gadget;
254 struct ffs_data *ffs;
258 short *interfaces_nums;
260 struct usb_function function;
264 static struct ffs_function *ffs_func_from_usb(struct usb_function *f)
266 return container_of(f, struct ffs_function, function);
269 static void ffs_func_free(struct ffs_function *func);
272 static void ffs_func_eps_disable(struct ffs_function *func);
273 static int __must_check ffs_func_eps_enable(struct ffs_function *func);
276 static int ffs_func_bind(struct usb_configuration *,
277 struct usb_function *);
278 static void ffs_func_unbind(struct usb_configuration *,
279 struct usb_function *);
280 static int ffs_func_set_alt(struct usb_function *, unsigned, unsigned);
281 static void ffs_func_disable(struct usb_function *);
282 static int ffs_func_setup(struct usb_function *,
283 const struct usb_ctrlrequest *);
284 static void ffs_func_suspend(struct usb_function *);
285 static void ffs_func_resume(struct usb_function *);
288 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num);
289 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf);
293 /* The endpoints structures *************************************************/
296 struct usb_ep *ep; /* P: ffs->eps_lock */
297 struct usb_request *req; /* P: epfile->mutex */
299 /* [0]: full speed, [1]: high speed */
300 struct usb_endpoint_descriptor *descs[2];
304 int status; /* P: epfile->mutex */
308 /* Protects ep->ep and ep->req. */
310 wait_queue_head_t wait;
312 struct ffs_data *ffs;
313 struct ffs_ep *ep; /* P: ffs->eps_lock */
315 struct dentry *dentry;
319 unsigned char in; /* P: ffs->eps_lock */
320 unsigned char isoc; /* P: ffs->eps_lock */
326 static int __must_check ffs_epfiles_create(struct ffs_data *ffs);
327 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count);
329 static struct inode *__must_check
330 ffs_sb_create_file(struct super_block *sb, const char *name, void *data,
331 const struct file_operations *fops,
332 struct dentry **dentry_p);
335 /* Misc helper functions ****************************************************/
337 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
338 __attribute__((warn_unused_result, nonnull));
339 static char *ffs_prepare_buffer(const char * __user buf, size_t len)
340 __attribute__((warn_unused_result, nonnull));
343 /* Control file aka ep0 *****************************************************/
345 static void ffs_ep0_complete(struct usb_ep *ep, struct usb_request *req)
347 struct ffs_data *ffs = req->context;
349 complete_all(&ffs->ep0req_completion);
353 static int __ffs_ep0_queue_wait(struct ffs_data *ffs, char *data, size_t len)
355 struct usb_request *req = ffs->ep0req;
358 req->zero = len < le16_to_cpu(ffs->ev.setup.wLength);
360 spin_unlock_irq(&ffs->ev.waitq.lock);
365 INIT_COMPLETION(ffs->ep0req_completion);
367 ret = usb_ep_queue(ffs->gadget->ep0, req, GFP_ATOMIC);
368 if (unlikely(ret < 0))
371 ret = wait_for_completion_interruptible(&ffs->ep0req_completion);
373 usb_ep_dequeue(ffs->gadget->ep0, req);
377 ffs->setup_state = FFS_NO_SETUP;
378 return ffs->ep0req_status;
381 static int __ffs_ep0_stall(struct ffs_data *ffs)
383 if (ffs->ev.can_stall) {
384 FVDBG("ep0 stall\n");
385 usb_ep_set_halt(ffs->gadget->ep0);
386 ffs->setup_state = FFS_NO_SETUP;
389 FDBG("bogus ep0 stall!\n");
395 static ssize_t ffs_ep0_write(struct file *file, const char __user *buf,
396 size_t len, loff_t *ptr)
398 struct ffs_data *ffs = file->private_data;
404 /* Fast check if setup was canceled */
405 if (FFS_SETUP_STATE(ffs) == FFS_SETUP_CANCELED)
409 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
410 if (unlikely(ret < 0))
415 switch (ffs->state) {
416 case FFS_READ_DESCRIPTORS:
417 case FFS_READ_STRINGS:
419 if (unlikely(len < 16)) {
424 data = ffs_prepare_buffer(buf, len);
425 if (unlikely(IS_ERR(data))) {
431 if (ffs->state == FFS_READ_DESCRIPTORS) {
432 FINFO("read descriptors");
433 ret = __ffs_data_got_descs(ffs, data, len);
434 if (unlikely(ret < 0))
437 ffs->state = FFS_READ_STRINGS;
440 FINFO("read strings");
441 ret = __ffs_data_got_strings(ffs, data, len);
442 if (unlikely(ret < 0))
445 ret = ffs_epfiles_create(ffs);
447 ffs->state = FFS_CLOSING;
451 ffs->state = FFS_ACTIVE;
452 mutex_unlock(&ffs->mutex);
454 ret = functionfs_ready_callback(ffs);
455 if (unlikely(ret < 0)) {
456 ffs->state = FFS_CLOSING;
460 set_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags);
468 /* We're called from user space, we can use _irq
469 * rather then _irqsave */
470 spin_lock_irq(&ffs->ev.waitq.lock);
471 switch (FFS_SETUP_STATE(ffs)) {
472 case FFS_SETUP_CANCELED:
480 case FFS_SETUP_PENDING:
484 /* FFS_SETUP_PENDING */
485 if (!(ffs->ev.setup.bRequestType & USB_DIR_IN)) {
486 spin_unlock_irq(&ffs->ev.waitq.lock);
487 ret = __ffs_ep0_stall(ffs);
491 /* FFS_SETUP_PENDING and not stall */
492 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
494 spin_unlock_irq(&ffs->ev.waitq.lock);
496 data = ffs_prepare_buffer(buf, len);
497 if (unlikely(IS_ERR(data))) {
502 spin_lock_irq(&ffs->ev.waitq.lock);
504 /* We are guaranteed to be still in FFS_ACTIVE state
505 * but the state of setup could have changed from
506 * FFS_SETUP_PENDING to FFS_SETUP_CANCELED so we need
507 * to check for that. If that happened we copied data
508 * from user space in vain but it's unlikely. */
509 /* For sure we are not in FFS_NO_SETUP since this is
510 * the only place FFS_SETUP_PENDING -> FFS_NO_SETUP
511 * transition can be performed and it's protected by
514 if (FFS_SETUP_STATE(ffs) == FFS_SETUP_CANCELED) {
517 spin_unlock_irq(&ffs->ev.waitq.lock);
519 /* unlocks spinlock */
520 ret = __ffs_ep0_queue_wait(ffs, data, len);
532 mutex_unlock(&ffs->mutex);
538 static ssize_t __ffs_ep0_read_events(struct ffs_data *ffs, char __user *buf,
541 /* We are holding ffs->ev.waitq.lock and ffs->mutex and we need
542 * to release them. */
544 struct usb_functionfs_event events[n];
547 memset(events, 0, sizeof events);
550 events[i].type = ffs->ev.types[i];
551 if (events[i].type == FUNCTIONFS_SETUP) {
552 events[i].u.setup = ffs->ev.setup;
553 ffs->setup_state = FFS_SETUP_PENDING;
557 if (n < ffs->ev.count) {
559 memmove(ffs->ev.types, ffs->ev.types + n,
560 ffs->ev.count * sizeof *ffs->ev.types);
565 spin_unlock_irq(&ffs->ev.waitq.lock);
566 mutex_unlock(&ffs->mutex);
568 return unlikely(__copy_to_user(buf, events, sizeof events))
569 ? -EFAULT : sizeof events;
573 static ssize_t ffs_ep0_read(struct file *file, char __user *buf,
574 size_t len, loff_t *ptr)
576 struct ffs_data *ffs = file->private_data;
583 /* Fast check if setup was canceled */
584 if (FFS_SETUP_STATE(ffs) == FFS_SETUP_CANCELED)
588 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
589 if (unlikely(ret < 0))
594 if (ffs->state != FFS_ACTIVE) {
600 /* We're called from user space, we can use _irq rather then
602 spin_lock_irq(&ffs->ev.waitq.lock);
604 switch (FFS_SETUP_STATE(ffs)) {
605 case FFS_SETUP_CANCELED:
610 n = len / sizeof(struct usb_functionfs_event);
616 if ((file->f_flags & O_NONBLOCK) && !ffs->ev.count) {
621 if (unlikely(wait_event_interruptible_exclusive_locked_irq(ffs->ev.waitq, ffs->ev.count))) {
626 return __ffs_ep0_read_events(ffs, buf,
627 min(n, (size_t)ffs->ev.count));
630 case FFS_SETUP_PENDING:
631 if (ffs->ev.setup.bRequestType & USB_DIR_IN) {
632 spin_unlock_irq(&ffs->ev.waitq.lock);
633 ret = __ffs_ep0_stall(ffs);
637 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
639 spin_unlock_irq(&ffs->ev.waitq.lock);
642 data = kmalloc(len, GFP_KERNEL);
643 if (unlikely(!data)) {
649 spin_lock_irq(&ffs->ev.waitq.lock);
651 /* See ffs_ep0_write() */
652 if (FFS_SETUP_STATE(ffs) == FFS_SETUP_CANCELED) {
657 /* unlocks spinlock */
658 ret = __ffs_ep0_queue_wait(ffs, data, len);
659 if (likely(ret > 0) && unlikely(__copy_to_user(buf, data, len)))
668 spin_unlock_irq(&ffs->ev.waitq.lock);
670 mutex_unlock(&ffs->mutex);
677 static int ffs_ep0_open(struct inode *inode, struct file *file)
679 struct ffs_data *ffs = inode->i_private;
683 if (unlikely(ffs->state == FFS_CLOSING))
686 file->private_data = ffs;
687 ffs_data_opened(ffs);
693 static int ffs_ep0_release(struct inode *inode, struct file *file)
695 struct ffs_data *ffs = file->private_data;
699 ffs_data_closed(ffs);
705 static long ffs_ep0_ioctl(struct file *file, unsigned code, unsigned long value)
707 struct ffs_data *ffs = file->private_data;
708 struct usb_gadget *gadget = ffs->gadget;
713 if (code == FUNCTIONFS_INTERFACE_REVMAP) {
714 struct ffs_function *func = ffs->func;
715 ret = func ? ffs_func_revmap_intf(func, value) : -ENODEV;
716 } else if (gadget->ops->ioctl) {
718 ret = gadget->ops->ioctl(gadget, code, value);
728 static const struct file_operations ffs_ep0_operations = {
729 .owner = THIS_MODULE,
732 .open = ffs_ep0_open,
733 .write = ffs_ep0_write,
734 .read = ffs_ep0_read,
735 .release = ffs_ep0_release,
736 .unlocked_ioctl = ffs_ep0_ioctl,
740 /* "Normal" endpoints operations ********************************************/
743 static void ffs_epfile_io_complete(struct usb_ep *_ep, struct usb_request *req)
746 if (likely(req->context)) {
747 struct ffs_ep *ep = _ep->driver_data;
748 ep->status = req->status ? req->status : req->actual;
749 complete(req->context);
754 static ssize_t ffs_epfile_io(struct file *file,
755 char __user *buf, size_t len, int read)
757 struct ffs_epfile *epfile = file->private_data;
765 spin_unlock_irq(&epfile->ffs->eps_lock);
766 mutex_unlock(&epfile->mutex);
769 /* Are we still active? */
770 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
775 /* Wait for endpoint to be enabled */
778 if (file->f_flags & O_NONBLOCK) {
783 if (unlikely(wait_event_interruptible
784 (epfile->wait, (ep = epfile->ep)))) {
791 halt = !read == !epfile->in;
792 if (halt && epfile->isoc) {
797 /* Allocate & copy */
798 if (!halt && !data) {
799 data = kzalloc(len, GFP_KERNEL);
804 unlikely(__copy_from_user(data, buf, len))) {
810 /* We will be using request */
811 ret = ffs_mutex_lock(&epfile->mutex,
812 file->f_flags & O_NONBLOCK);
816 /* We're called from user space, we can use _irq rather then
818 spin_lock_irq(&epfile->ffs->eps_lock);
820 /* While we were acquiring mutex endpoint got disabled
822 } while (unlikely(epfile->ep != ep));
825 if (unlikely(halt)) {
826 if (likely(epfile->ep == ep) && !WARN_ON(!ep->ep))
827 usb_ep_set_halt(ep->ep);
828 spin_unlock_irq(&epfile->ffs->eps_lock);
831 /* Fire the request */
832 DECLARE_COMPLETION_ONSTACK(done);
834 struct usb_request *req = ep->req;
835 req->context = &done;
836 req->complete = ffs_epfile_io_complete;
840 ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
842 spin_unlock_irq(&epfile->ffs->eps_lock);
844 if (unlikely(ret < 0)) {
846 } else if (unlikely(wait_for_completion_interruptible(&done))) {
848 usb_ep_dequeue(ep->ep, req);
851 if (read && ret > 0 &&
852 unlikely(copy_to_user(buf, data, ret)))
857 mutex_unlock(&epfile->mutex);
865 ffs_epfile_write(struct file *file, const char __user *buf, size_t len,
870 return ffs_epfile_io(file, (char __user *)buf, len, 0);
874 ffs_epfile_read(struct file *file, char __user *buf, size_t len, loff_t *ptr)
878 return ffs_epfile_io(file, buf, len, 1);
882 ffs_epfile_open(struct inode *inode, struct file *file)
884 struct ffs_epfile *epfile = inode->i_private;
888 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
891 file->private_data = epfile;
892 ffs_data_opened(epfile->ffs);
898 ffs_epfile_release(struct inode *inode, struct file *file)
900 struct ffs_epfile *epfile = inode->i_private;
904 ffs_data_closed(epfile->ffs);
910 static long ffs_epfile_ioctl(struct file *file, unsigned code,
913 struct ffs_epfile *epfile = file->private_data;
918 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
921 spin_lock_irq(&epfile->ffs->eps_lock);
922 if (likely(epfile->ep)) {
924 case FUNCTIONFS_FIFO_STATUS:
925 ret = usb_ep_fifo_status(epfile->ep->ep);
927 case FUNCTIONFS_FIFO_FLUSH:
928 usb_ep_fifo_flush(epfile->ep->ep);
931 case FUNCTIONFS_CLEAR_HALT:
932 ret = usb_ep_clear_halt(epfile->ep->ep);
934 case FUNCTIONFS_ENDPOINT_REVMAP:
935 ret = epfile->ep->num;
943 spin_unlock_irq(&epfile->ffs->eps_lock);
949 static const struct file_operations ffs_epfile_operations = {
950 .owner = THIS_MODULE,
953 .open = ffs_epfile_open,
954 .write = ffs_epfile_write,
955 .read = ffs_epfile_read,
956 .release = ffs_epfile_release,
957 .unlocked_ioctl = ffs_epfile_ioctl,
962 /* File system and super block operations ***********************************/
965 * Mounting the filesystem creates a controller file, used first for
966 * function configuration then later for event monitoring.
970 static struct inode *__must_check
971 ffs_sb_make_inode(struct super_block *sb, void *data,
972 const struct file_operations *fops,
973 const struct inode_operations *iops,
974 struct ffs_file_perms *perms)
980 inode = new_inode(sb);
983 struct timespec current_time = CURRENT_TIME;
985 inode->i_mode = perms->mode;
986 inode->i_uid = perms->uid;
987 inode->i_gid = perms->gid;
988 inode->i_atime = current_time;
989 inode->i_mtime = current_time;
990 inode->i_ctime = current_time;
991 inode->i_private = data;
1002 /* Create "regular" file */
1004 static struct inode *ffs_sb_create_file(struct super_block *sb,
1005 const char *name, void *data,
1006 const struct file_operations *fops,
1007 struct dentry **dentry_p)
1009 struct ffs_data *ffs = sb->s_fs_info;
1010 struct dentry *dentry;
1011 struct inode *inode;
1015 dentry = d_alloc_name(sb->s_root, name);
1016 if (unlikely(!dentry))
1019 inode = ffs_sb_make_inode(sb, data, fops, NULL, &ffs->file_perms);
1020 if (unlikely(!inode)) {
1025 d_add(dentry, inode);
1035 static const struct super_operations ffs_sb_operations = {
1036 .statfs = simple_statfs,
1037 .drop_inode = generic_delete_inode,
1040 struct ffs_sb_fill_data {
1041 struct ffs_file_perms perms;
1043 const char *dev_name;
1046 static int ffs_sb_fill(struct super_block *sb, void *_data, int silent)
1048 struct ffs_sb_fill_data *data = _data;
1049 struct inode *inode;
1051 struct ffs_data *ffs;
1055 /* Initialize data */
1056 ffs = ffs_data_new();
1061 ffs->dev_name = data->dev_name;
1062 ffs->file_perms = data->perms;
1064 sb->s_fs_info = ffs;
1065 sb->s_blocksize = PAGE_CACHE_SIZE;
1066 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
1067 sb->s_magic = FUNCTIONFS_MAGIC;
1068 sb->s_op = &ffs_sb_operations;
1069 sb->s_time_gran = 1;
1072 data->perms.mode = data->root_mode;
1073 inode = ffs_sb_make_inode(sb, NULL,
1074 &simple_dir_operations,
1075 &simple_dir_inode_operations,
1077 if (unlikely(!inode))
1079 d = d_alloc_root(inode);
1085 if (unlikely(!ffs_sb_create_file(sb, "ep0", ffs,
1086 &ffs_ep0_operations, NULL)))
1102 static int ffs_fs_parse_opts(struct ffs_sb_fill_data *data, char *opts)
1106 if (!opts || !*opts)
1110 char *end, *eq, *comma;
1111 unsigned long value;
1114 comma = strchr(opts, ',');
1119 eq = strchr(opts, '=');
1120 if (unlikely(!eq)) {
1121 FERR("'=' missing in %s", opts);
1127 value = simple_strtoul(eq + 1, &end, 0);
1128 if (unlikely(*end != ',' && *end != 0)) {
1129 FERR("%s: invalid value: %s", opts, eq + 1);
1133 /* Interpret option */
1134 switch (eq - opts) {
1136 if (!memcmp(opts, "rmode", 5))
1137 data->root_mode = (value & 0555) | S_IFDIR;
1138 else if (!memcmp(opts, "fmode", 5))
1139 data->perms.mode = (value & 0666) | S_IFREG;
1145 if (!memcmp(opts, "mode", 4)) {
1146 data->root_mode = (value & 0555) | S_IFDIR;
1147 data->perms.mode = (value & 0666) | S_IFREG;
1154 if (!memcmp(opts, "uid", 3))
1155 data->perms.uid = value;
1156 else if (!memcmp(opts, "gid", 3))
1157 data->perms.gid = value;
1164 FERR("%s: invalid option", opts);
1168 /* Next iteration */
1178 /* "mount -t functionfs dev_name /dev/function" ends up here */
1181 ffs_fs_get_sb(struct file_system_type *t, int flags,
1182 const char *dev_name, void *opts, struct vfsmount *mnt)
1184 struct ffs_sb_fill_data data = {
1186 .mode = S_IFREG | 0600,
1190 .root_mode = S_IFDIR | 0500,
1196 ret = functionfs_check_dev_callback(dev_name);
1197 if (unlikely(ret < 0))
1200 ret = ffs_fs_parse_opts(&data, opts);
1201 if (unlikely(ret < 0))
1204 data.dev_name = dev_name;
1205 return get_sb_single(t, flags, &data, ffs_sb_fill, mnt);
1209 ffs_fs_kill_sb(struct super_block *sb)
1215 kill_litter_super(sb);
1216 ptr = xchg(&sb->s_fs_info, NULL);
1221 static struct file_system_type ffs_fs_type = {
1222 .owner = THIS_MODULE,
1223 .name = "functionfs",
1224 .get_sb = ffs_fs_get_sb,
1225 .kill_sb = ffs_fs_kill_sb,
1230 /* Driver's main init/cleanup functions *************************************/
1233 static int functionfs_init(void)
1239 ret = register_filesystem(&ffs_fs_type);
1241 FINFO("file system registered");
1243 FERR("failed registering file system (%d)", ret);
1248 static void functionfs_cleanup(void)
1253 unregister_filesystem(&ffs_fs_type);
1258 /* ffs_data and ffs_function construction and destruction code **************/
1260 static void ffs_data_clear(struct ffs_data *ffs);
1261 static void ffs_data_reset(struct ffs_data *ffs);
1264 static void ffs_data_get(struct ffs_data *ffs)
1268 atomic_inc(&ffs->ref);
1271 static void ffs_data_opened(struct ffs_data *ffs)
1275 atomic_inc(&ffs->ref);
1276 atomic_inc(&ffs->opened);
1279 static void ffs_data_put(struct ffs_data *ffs)
1283 if (unlikely(atomic_dec_and_test(&ffs->ref))) {
1284 FINFO("%s(): freeing", __func__);
1285 ffs_data_clear(ffs);
1286 BUG_ON(mutex_is_locked(&ffs->mutex) ||
1287 spin_is_locked(&ffs->ev.waitq.lock) ||
1288 waitqueue_active(&ffs->ev.waitq) ||
1289 waitqueue_active(&ffs->ep0req_completion.wait));
1296 static void ffs_data_closed(struct ffs_data *ffs)
1300 if (atomic_dec_and_test(&ffs->opened)) {
1301 ffs->state = FFS_CLOSING;
1302 ffs_data_reset(ffs);
1309 static struct ffs_data *ffs_data_new(void)
1311 struct ffs_data *ffs = kzalloc(sizeof *ffs, GFP_KERNEL);
1317 atomic_set(&ffs->ref, 1);
1318 atomic_set(&ffs->opened, 0);
1319 ffs->state = FFS_READ_DESCRIPTORS;
1320 mutex_init(&ffs->mutex);
1321 spin_lock_init(&ffs->eps_lock);
1322 init_waitqueue_head(&ffs->ev.waitq);
1323 init_completion(&ffs->ep0req_completion);
1325 /* XXX REVISIT need to update it in some places, or do we? */
1326 ffs->ev.can_stall = 1;
1332 static void ffs_data_clear(struct ffs_data *ffs)
1336 if (test_and_clear_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags))
1337 functionfs_closed_callback(ffs);
1339 BUG_ON(ffs->gadget);
1342 ffs_epfiles_destroy(ffs->epfiles, ffs->eps_count);
1344 kfree(ffs->raw_descs);
1345 kfree(ffs->raw_strings);
1346 kfree(ffs->stringtabs);
1350 static void ffs_data_reset(struct ffs_data *ffs)
1354 ffs_data_clear(ffs);
1356 ffs->epfiles = NULL;
1357 ffs->raw_descs = NULL;
1358 ffs->raw_strings = NULL;
1359 ffs->stringtabs = NULL;
1361 ffs->raw_descs_length = 0;
1362 ffs->raw_fs_descs_length = 0;
1363 ffs->fs_descs_count = 0;
1364 ffs->hs_descs_count = 0;
1366 ffs->strings_count = 0;
1367 ffs->interfaces_count = 0;
1372 ffs->state = FFS_READ_DESCRIPTORS;
1373 ffs->setup_state = FFS_NO_SETUP;
1378 static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
1384 if (WARN_ON(ffs->state != FFS_ACTIVE
1385 || test_and_set_bit(FFS_FL_BOUND, &ffs->flags)))
1390 ffs->ep0req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL);
1391 if (unlikely(!ffs->ep0req))
1393 ffs->ep0req->complete = ffs_ep0_complete;
1394 ffs->ep0req->context = ffs;
1396 /* Get strings identifiers */
1397 for (count = ffs->strings_count, i = 0; i < count; ++i) {
1398 struct usb_gadget_strings **lang;
1400 int id = usb_string_id(cdev);
1401 if (unlikely(id < 0)) {
1402 usb_ep_free_request(cdev->gadget->ep0, ffs->ep0req);
1407 lang = ffs->stringtabs;
1409 (*lang)->strings[i].id = id;
1414 ffs->gadget = cdev->gadget;
1419 static void functionfs_unbind(struct ffs_data *ffs)
1423 if (!WARN_ON(!ffs->gadget)) {
1424 usb_ep_free_request(ffs->gadget->ep0, ffs->ep0req);
1432 static int ffs_epfiles_create(struct ffs_data *ffs)
1434 struct ffs_epfile *epfile, *epfiles;
1439 count = ffs->eps_count;
1440 epfiles = kzalloc(count * sizeof *epfiles, GFP_KERNEL);
1445 for (i = 1; i <= count; ++i, ++epfile) {
1447 mutex_init(&epfile->mutex);
1448 init_waitqueue_head(&epfile->wait);
1449 sprintf(epfiles->name, "ep%u", i);
1450 if (!unlikely(ffs_sb_create_file(ffs->sb, epfiles->name, epfile,
1451 &ffs_epfile_operations,
1452 &epfile->dentry))) {
1453 ffs_epfiles_destroy(epfiles, i - 1);
1458 ffs->epfiles = epfiles;
1463 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count)
1465 struct ffs_epfile *epfile = epfiles;
1469 for (; count; --count, ++epfile) {
1470 BUG_ON(mutex_is_locked(&epfile->mutex) ||
1471 waitqueue_active(&epfile->wait));
1472 if (epfile->dentry) {
1473 d_delete(epfile->dentry);
1474 dput(epfile->dentry);
1475 epfile->dentry = NULL;
1483 static int functionfs_add(struct usb_composite_dev *cdev,
1484 struct usb_configuration *c,
1485 struct ffs_data *ffs)
1487 struct ffs_function *func;
1492 func = kzalloc(sizeof *func, GFP_KERNEL);
1493 if (unlikely(!func))
1496 func->function.name = "Function FS Gadget";
1497 func->function.strings = ffs->stringtabs;
1499 func->function.bind = ffs_func_bind;
1500 func->function.unbind = ffs_func_unbind;
1501 func->function.set_alt = ffs_func_set_alt;
1502 /*func->function.get_alt = ffs_func_get_alt;*/
1503 func->function.disable = ffs_func_disable;
1504 func->function.setup = ffs_func_setup;
1505 func->function.suspend = ffs_func_suspend;
1506 func->function.resume = ffs_func_resume;
1509 func->gadget = cdev->gadget;
1513 ret = usb_add_function(c, &func->function);
1515 ffs_func_free(func);
1520 static void ffs_func_free(struct ffs_function *func)
1524 ffs_data_put(func->ffs);
1527 /* eps and interfaces_nums are allocated in the same chunk so
1528 * only one free is required. Descriptors are also allocated
1529 * in the same chunk. */
1535 static void ffs_func_eps_disable(struct ffs_function *func)
1537 struct ffs_ep *ep = func->eps;
1538 struct ffs_epfile *epfile = func->ffs->epfiles;
1539 unsigned count = func->ffs->eps_count;
1540 unsigned long flags;
1542 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1544 /* pending requests get nuked */
1546 usb_ep_disable(ep->ep);
1552 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1555 static int ffs_func_eps_enable(struct ffs_function *func)
1557 struct ffs_data *ffs = func->ffs;
1558 struct ffs_ep *ep = func->eps;
1559 struct ffs_epfile *epfile = ffs->epfiles;
1560 unsigned count = ffs->eps_count;
1561 unsigned long flags;
1564 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1566 struct usb_endpoint_descriptor *ds;
1567 ds = ep->descs[ep->descs[1] ? 1 : 0];
1569 ep->ep->driver_data = ep;
1570 ret = usb_ep_enable(ep->ep, ds);
1573 epfile->in = usb_endpoint_dir_in(ds);
1574 epfile->isoc = usb_endpoint_xfer_isoc(ds);
1579 wake_up(&epfile->wait);
1584 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1590 /* Parsing and building descriptors and strings *****************************/
1593 /* This validates if data pointed by data is a valid USB descriptor as
1594 * well as record how many interfaces, endpoints and strings are
1595 * required by given configuration. Returns address afther the
1596 * descriptor or NULL if data is invalid. */
1598 enum ffs_entity_type {
1599 FFS_DESCRIPTOR, FFS_INTERFACE, FFS_STRING, FFS_ENDPOINT
1602 typedef int (*ffs_entity_callback)(enum ffs_entity_type entity,
1604 struct usb_descriptor_header *desc,
1607 static int __must_check ffs_do_desc(char *data, unsigned len,
1608 ffs_entity_callback entity, void *priv)
1610 struct usb_descriptor_header *_ds = (void *)data;
1616 /* At least two bytes are required: length and type */
1618 FVDBG("descriptor too short");
1622 /* If we have at least as many bytes as the descriptor takes? */
1623 length = _ds->bLength;
1625 FVDBG("descriptor longer then available data");
1629 #define __entity_check_INTERFACE(val) 1
1630 #define __entity_check_STRING(val) (val)
1631 #define __entity_check_ENDPOINT(val) ((val) & USB_ENDPOINT_NUMBER_MASK)
1632 #define __entity(type, val) do { \
1633 FVDBG("entity " #type "(%02x)", (val)); \
1634 if (unlikely(!__entity_check_ ##type(val))) { \
1635 FVDBG("invalid entity's value"); \
1638 ret = entity(FFS_ ##type, &val, _ds, priv); \
1639 if (unlikely(ret < 0)) { \
1640 FDBG("entity " #type "(%02x); ret = %d", \
1646 /* Parse descriptor depending on type. */
1647 switch (_ds->bDescriptorType) {
1651 case USB_DT_DEVICE_QUALIFIER:
1652 /* function can't have any of those */
1653 FVDBG("descriptor reserved for gadget: %d", _ds->bDescriptorType);
1656 case USB_DT_INTERFACE: {
1657 struct usb_interface_descriptor *ds = (void *)_ds;
1658 FVDBG("interface descriptor");
1659 if (length != sizeof *ds)
1662 __entity(INTERFACE, ds->bInterfaceNumber);
1664 __entity(STRING, ds->iInterface);
1668 case USB_DT_ENDPOINT: {
1669 struct usb_endpoint_descriptor *ds = (void *)_ds;
1670 FVDBG("endpoint descriptor");
1671 if (length != USB_DT_ENDPOINT_SIZE &&
1672 length != USB_DT_ENDPOINT_AUDIO_SIZE)
1674 __entity(ENDPOINT, ds->bEndpointAddress);
1679 if (length != sizeof(struct usb_otg_descriptor))
1683 case USB_DT_INTERFACE_ASSOCIATION: {
1684 struct usb_interface_assoc_descriptor *ds = (void *)_ds;
1685 FVDBG("interface association descriptor");
1686 if (length != sizeof *ds)
1689 __entity(STRING, ds->iFunction);
1693 case USB_DT_OTHER_SPEED_CONFIG:
1694 case USB_DT_INTERFACE_POWER:
1696 case USB_DT_SECURITY:
1697 case USB_DT_CS_RADIO_CONTROL:
1699 FVDBG("unimplemented descriptor: %d", _ds->bDescriptorType);
1703 /* We should never be here */
1704 FVDBG("unknown descriptor: %d", _ds->bDescriptorType);
1708 FVDBG("invalid length: %d (descriptor %d)",
1709 _ds->bLength, _ds->bDescriptorType);
1714 #undef __entity_check_DESCRIPTOR
1715 #undef __entity_check_INTERFACE
1716 #undef __entity_check_STRING
1717 #undef __entity_check_ENDPOINT
1723 static int __must_check ffs_do_descs(unsigned count, char *data, unsigned len,
1724 ffs_entity_callback entity, void *priv)
1726 const unsigned _len = len;
1727 unsigned long num = 0;
1737 /* Record "descriptor" entitny */
1738 ret = entity(FFS_DESCRIPTOR, (u8 *)num, (void *)data, priv);
1739 if (unlikely(ret < 0)) {
1740 FDBG("entity DESCRIPTOR(%02lx); ret = %d", num, ret);
1747 ret = ffs_do_desc(data, len, entity, priv);
1748 if (unlikely(ret < 0)) {
1749 FDBG("%s returns %d", __func__, ret);
1760 static int __ffs_data_do_entity(enum ffs_entity_type type,
1761 u8 *valuep, struct usb_descriptor_header *desc,
1764 struct ffs_data *ffs = priv;
1769 case FFS_DESCRIPTOR:
1773 /* Interfaces are indexed from zero so if we
1774 * encountered interface "n" then there are at least
1775 * "n+1" interfaces. */
1776 if (*valuep >= ffs->interfaces_count)
1777 ffs->interfaces_count = *valuep + 1;
1781 /* Strings are indexed from 1 (0 is magic ;) reserved
1782 * for languages list or some such) */
1783 if (*valuep > ffs->strings_count)
1784 ffs->strings_count = *valuep;
1788 /* Endpoints are indexed from 1 as well. */
1789 if ((*valuep & USB_ENDPOINT_NUMBER_MASK) > ffs->eps_count)
1790 ffs->eps_count = (*valuep & USB_ENDPOINT_NUMBER_MASK);
1798 static int __ffs_data_got_descs(struct ffs_data *ffs,
1799 char *const _data, size_t len)
1801 unsigned fs_count, hs_count;
1802 int fs_len, ret = -EINVAL;
1807 if (unlikely(get_unaligned_le32(data) != FUNCTIONFS_DESCRIPTORS_MAGIC ||
1808 get_unaligned_le32(data + 4) != len))
1810 fs_count = get_unaligned_le32(data + 8);
1811 hs_count = get_unaligned_le32(data + 12);
1813 if (!fs_count && !hs_count)
1819 if (likely(fs_count)) {
1820 fs_len = ffs_do_descs(fs_count, data, len,
1821 __ffs_data_do_entity, ffs);
1822 if (unlikely(fs_len < 0)) {
1833 if (likely(hs_count)) {
1834 ret = ffs_do_descs(hs_count, data, len,
1835 __ffs_data_do_entity, ffs);
1836 if (unlikely(ret < 0))
1842 if (unlikely(len != ret))
1845 ffs->raw_fs_descs_length = fs_len;
1846 ffs->raw_descs_length = fs_len + ret;
1847 ffs->raw_descs = _data;
1848 ffs->fs_descs_count = fs_count;
1849 ffs->hs_descs_count = hs_count;
1862 static int __ffs_data_got_strings(struct ffs_data *ffs,
1863 char *const _data, size_t len)
1865 u32 str_count, needed_count, lang_count;
1866 struct usb_gadget_strings **stringtabs, *t;
1867 struct usb_string *strings, *s;
1868 const char *data = _data;
1872 if (unlikely(get_unaligned_le32(data) != FUNCTIONFS_STRINGS_MAGIC ||
1873 get_unaligned_le32(data + 4) != len))
1875 str_count = get_unaligned_le32(data + 8);
1876 lang_count = get_unaligned_le32(data + 12);
1878 /* if one is zero the other must be zero */
1879 if (unlikely(!str_count != !lang_count))
1882 /* Do we have at least as many strings as descriptors need? */
1883 needed_count = ffs->strings_count;
1884 if (unlikely(str_count < needed_count))
1887 /* If we don't need any strings just return and free all
1889 if (!needed_count) {
1896 /* Allocate everything in one chunk so there's less
1899 struct usb_gadget_strings *stringtabs[lang_count + 1];
1900 struct usb_gadget_strings stringtab[lang_count];
1901 struct usb_string strings[lang_count*(needed_count+1)];
1905 d = kmalloc(sizeof *d, GFP_KERNEL);
1911 stringtabs = d->stringtabs;
1915 *stringtabs++ = t++;
1919 stringtabs = d->stringtabs;
1925 /* For each language */
1929 do { /* lang_count > 0 so we can use do-while */
1930 unsigned needed = needed_count;
1932 if (unlikely(len < 3))
1934 t->language = get_unaligned_le16(data);
1941 /* For each string */
1942 do { /* str_count > 0 so we can use do-while */
1943 size_t length = strnlen(data, len);
1945 if (unlikely(length == len))
1948 /* user may provide more strings then we need,
1949 * if that's the case we simply ingore the
1951 if (likely(needed)) {
1952 /* s->id will be set while adding
1953 * function to configuration so for
1954 * now just leave garbage here. */
1962 } while (--str_count);
1964 s->id = 0; /* terminator */
1968 } while (--lang_count);
1970 /* Some garbage left? */
1975 ffs->stringtabs = stringtabs;
1976 ffs->raw_strings = _data;
1990 /* Events handling and management *******************************************/
1992 static void __ffs_event_add(struct ffs_data *ffs,
1993 enum usb_functionfs_event_type type)
1995 enum usb_functionfs_event_type rem_type1, rem_type2 = type;
1998 /* Abort any unhandled setup */
1999 /* We do not need to worry about some cmpxchg() changing value
2000 * of ffs->setup_state without holding the lock because when
2001 * state is FFS_SETUP_PENDING cmpxchg() in several places in
2002 * the source does nothing. */
2003 if (ffs->setup_state == FFS_SETUP_PENDING)
2004 ffs->setup_state = FFS_SETUP_CANCELED;
2007 case FUNCTIONFS_RESUME:
2008 rem_type2 = FUNCTIONFS_SUSPEND;
2010 case FUNCTIONFS_SUSPEND:
2011 case FUNCTIONFS_SETUP:
2013 /* discard all similar events */
2016 case FUNCTIONFS_BIND:
2017 case FUNCTIONFS_UNBIND:
2018 case FUNCTIONFS_DISABLE:
2019 case FUNCTIONFS_ENABLE:
2020 /* discard everything other then power management. */
2021 rem_type1 = FUNCTIONFS_SUSPEND;
2022 rem_type2 = FUNCTIONFS_RESUME;
2031 u8 *ev = ffs->ev.types, *out = ev;
2032 unsigned n = ffs->ev.count;
2033 for (; n; --n, ++ev)
2034 if ((*ev == rem_type1 || *ev == rem_type2) == neg)
2037 FVDBG("purging event %d", *ev);
2038 ffs->ev.count = out - ffs->ev.types;
2041 FVDBG("adding event %d", type);
2042 ffs->ev.types[ffs->ev.count++] = type;
2043 wake_up_locked(&ffs->ev.waitq);
2046 static void ffs_event_add(struct ffs_data *ffs,
2047 enum usb_functionfs_event_type type)
2049 unsigned long flags;
2050 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
2051 __ffs_event_add(ffs, type);
2052 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
2056 /* Bind/unbind USB function hooks *******************************************/
2058 static int __ffs_func_bind_do_descs(enum ffs_entity_type type, u8 *valuep,
2059 struct usb_descriptor_header *desc,
2062 struct usb_endpoint_descriptor *ds = (void *)desc;
2063 struct ffs_function *func = priv;
2064 struct ffs_ep *ffs_ep;
2066 /* If hs_descriptors is not NULL then we are reading hs
2067 * descriptors now */
2068 const int isHS = func->function.hs_descriptors != NULL;
2071 if (type != FFS_DESCRIPTOR)
2075 func->function.hs_descriptors[(long)valuep] = desc;
2077 func->function.descriptors[(long)valuep] = desc;
2079 if (!desc || desc->bDescriptorType != USB_DT_ENDPOINT)
2082 idx = (ds->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK) - 1;
2083 ffs_ep = func->eps + idx;
2085 if (unlikely(ffs_ep->descs[isHS])) {
2086 FVDBG("two %sspeed descriptors for EP %d",
2087 isHS ? "high" : "full",
2088 ds->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
2091 ffs_ep->descs[isHS] = ds;
2093 ffs_dump_mem(": Original ep desc", ds, ds->bLength);
2095 ds->bEndpointAddress = ffs_ep->descs[0]->bEndpointAddress;
2096 if (!ds->wMaxPacketSize)
2097 ds->wMaxPacketSize = ffs_ep->descs[0]->wMaxPacketSize;
2099 struct usb_request *req;
2102 FVDBG("autoconfig");
2103 ep = usb_ep_autoconfig(func->gadget, ds);
2106 ep->driver_data = func->eps + idx;;
2108 req = usb_ep_alloc_request(ep, GFP_KERNEL);
2114 func->eps_revmap[ds->bEndpointAddress &
2115 USB_ENDPOINT_NUMBER_MASK] = idx + 1;
2117 ffs_dump_mem(": Rewritten ep desc", ds, ds->bLength);
2123 static int __ffs_func_bind_do_nums(enum ffs_entity_type type, u8 *valuep,
2124 struct usb_descriptor_header *desc,
2127 struct ffs_function *func = priv;
2133 case FFS_DESCRIPTOR:
2134 /* Handled in previous pass by __ffs_func_bind_do_descs() */
2139 if (func->interfaces_nums[idx] < 0) {
2140 int id = usb_interface_id(func->conf, &func->function);
2141 if (unlikely(id < 0))
2143 func->interfaces_nums[idx] = id;
2145 newValue = func->interfaces_nums[idx];
2149 /* String' IDs are allocated when fsf_data is bound to cdev */
2150 newValue = func->ffs->stringtabs[0]->strings[*valuep - 1].id;
2154 /* USB_DT_ENDPOINT are handled in
2155 * __ffs_func_bind_do_descs(). */
2156 if (desc->bDescriptorType == USB_DT_ENDPOINT)
2159 idx = (*valuep & USB_ENDPOINT_NUMBER_MASK) - 1;
2160 if (unlikely(!func->eps[idx].ep))
2164 struct usb_endpoint_descriptor **descs;
2165 descs = func->eps[idx].descs;
2166 newValue = descs[descs[0] ? 0 : 1]->bEndpointAddress;
2171 FVDBG("%02x -> %02x", *valuep, newValue);
2176 static int ffs_func_bind(struct usb_configuration *c,
2177 struct usb_function *f)
2179 struct ffs_function *func = ffs_func_from_usb(f);
2180 struct ffs_data *ffs = func->ffs;
2182 const int full = !!func->ffs->fs_descs_count;
2183 const int high = gadget_is_dualspeed(func->gadget) &&
2184 func->ffs->hs_descs_count;
2188 /* Make it a single chunk, less management later on */
2190 struct ffs_ep eps[ffs->eps_count];
2191 struct usb_descriptor_header
2192 *fs_descs[full ? ffs->fs_descs_count + 1 : 0];
2193 struct usb_descriptor_header
2194 *hs_descs[high ? ffs->hs_descs_count + 1 : 0];
2195 short inums[ffs->interfaces_count];
2196 char raw_descs[high ? ffs->raw_descs_length
2197 : ffs->raw_fs_descs_length];
2202 /* Only high speed but not supported by gadget? */
2203 if (unlikely(!(full | high)))
2207 data = kmalloc(sizeof *data, GFP_KERNEL);
2208 if (unlikely(!data))
2212 memset(data->eps, 0, sizeof data->eps);
2213 memcpy(data->raw_descs, ffs->raw_descs + 16, sizeof data->raw_descs);
2214 memset(data->inums, 0xff, sizeof data->inums);
2215 for (ret = ffs->eps_count; ret; --ret)
2216 data->eps[ret].num = -1;
2219 func->eps = data->eps;
2220 func->interfaces_nums = data->inums;
2222 /* Go throught all the endpoint descriptors and allocate
2223 * endpoints first, so that later we can rewrite the endpoint
2224 * numbers without worying that it may be described later on. */
2226 func->function.descriptors = data->fs_descs;
2227 ret = ffs_do_descs(ffs->fs_descs_count,
2229 sizeof data->raw_descs,
2230 __ffs_func_bind_do_descs, func);
2231 if (unlikely(ret < 0))
2238 func->function.hs_descriptors = data->hs_descs;
2239 ret = ffs_do_descs(ffs->hs_descs_count,
2240 data->raw_descs + ret,
2241 (sizeof data->raw_descs) - ret,
2242 __ffs_func_bind_do_descs, func);
2245 /* Now handle interface numbers allocation and interface and
2246 * enpoint numbers rewritting. We can do that in one go
2248 ret = ffs_do_descs(ffs->fs_descs_count +
2249 (high ? ffs->hs_descs_count : 0),
2250 data->raw_descs, sizeof data->raw_descs,
2251 __ffs_func_bind_do_nums, func);
2252 if (unlikely(ret < 0))
2255 /* And we're done */
2256 ffs_event_add(ffs, FUNCTIONFS_BIND);
2260 /* XXX Do we need to release all claimed endpoints here? */
2265 /* Other USB function hooks *************************************************/
2267 static void ffs_func_unbind(struct usb_configuration *c,
2268 struct usb_function *f)
2270 struct ffs_function *func = ffs_func_from_usb(f);
2271 struct ffs_data *ffs = func->ffs;
2275 if (ffs->func == func) {
2276 ffs_func_eps_disable(func);
2280 ffs_event_add(ffs, FUNCTIONFS_UNBIND);
2282 ffs_func_free(func);
2286 static int ffs_func_set_alt(struct usb_function *f,
2287 unsigned interface, unsigned alt)
2289 struct ffs_function *func = ffs_func_from_usb(f);
2290 struct ffs_data *ffs = func->ffs;
2293 if (alt != (unsigned)-1) {
2294 intf = ffs_func_revmap_intf(func, interface);
2295 if (unlikely(intf < 0))
2300 ffs_func_eps_disable(ffs->func);
2302 if (ffs->state != FFS_ACTIVE)
2305 if (alt == (unsigned)-1) {
2307 ffs_event_add(ffs, FUNCTIONFS_DISABLE);
2312 ret = ffs_func_eps_enable(func);
2313 if (likely(ret >= 0))
2314 ffs_event_add(ffs, FUNCTIONFS_ENABLE);
2318 static void ffs_func_disable(struct usb_function *f)
2320 ffs_func_set_alt(f, 0, (unsigned)-1);
2323 static int ffs_func_setup(struct usb_function *f,
2324 const struct usb_ctrlrequest *creq)
2326 struct ffs_function *func = ffs_func_from_usb(f);
2327 struct ffs_data *ffs = func->ffs;
2328 unsigned long flags;
2333 FVDBG("creq->bRequestType = %02x", creq->bRequestType);
2334 FVDBG("creq->bRequest = %02x", creq->bRequest);
2335 FVDBG("creq->wValue = %04x", le16_to_cpu(creq->wValue));
2336 FVDBG("creq->wIndex = %04x", le16_to_cpu(creq->wIndex));
2337 FVDBG("creq->wLength = %04x", le16_to_cpu(creq->wLength));
2339 /* Most requests directed to interface go throught here
2340 * (notable exceptions are set/get interface) so we need to
2341 * handle them. All other either handled by composite or
2342 * passed to usb_configuration->setup() (if one is set). No
2343 * matter, we will handle requests directed to endpoint here
2344 * as well (as it's straightforward) but what to do with any
2347 if (ffs->state != FFS_ACTIVE)
2350 switch (creq->bRequestType & USB_RECIP_MASK) {
2351 case USB_RECIP_INTERFACE:
2352 ret = ffs_func_revmap_intf(func, le16_to_cpu(creq->wIndex));
2353 if (unlikely(ret < 0))
2357 case USB_RECIP_ENDPOINT:
2358 ret = ffs_func_revmap_ep(func, le16_to_cpu(creq->wIndex));
2359 if (unlikely(ret < 0))
2367 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
2368 ffs->ev.setup = *creq;
2369 ffs->ev.setup.wIndex = cpu_to_le16(ret);
2370 __ffs_event_add(ffs, FUNCTIONFS_SETUP);
2371 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
2376 static void ffs_func_suspend(struct usb_function *f)
2379 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_SUSPEND);
2382 static void ffs_func_resume(struct usb_function *f)
2385 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_RESUME);
2390 /* Enpoint and interface numbers reverse mapping ****************************/
2392 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num)
2394 num = func->eps_revmap[num & USB_ENDPOINT_NUMBER_MASK];
2395 return num ? num : -EDOM;
2398 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf)
2400 short *nums = func->interfaces_nums;
2401 unsigned count = func->ffs->interfaces_count;
2403 for (; count; --count, ++nums) {
2404 if (*nums >= 0 && *nums == intf)
2405 return nums - func->interfaces_nums;
2412 /* Misc helper functions ****************************************************/
2414 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
2417 ? likely(mutex_trylock(mutex)) ? 0 : -EAGAIN
2418 : mutex_lock_interruptible(mutex);
2422 static char *ffs_prepare_buffer(const char * __user buf, size_t len)
2429 data = kmalloc(len, GFP_KERNEL);
2430 if (unlikely(!data))
2431 return ERR_PTR(-ENOMEM);
2433 if (unlikely(__copy_from_user(data, buf, len))) {
2435 return ERR_PTR(-EFAULT);
2438 FVDBG("Buffer from user space:");
2439 ffs_dump_mem("", data, len);