Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * inode.c -- user mode filesystem api for usb gadget controllers | |
3 | * | |
4 | * Copyright (C) 2003-2004 David Brownell | |
5 | * Copyright (C) 2003 Agilent Technologies | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
1da177e4 LT |
11 | */ |
12 | ||
13 | ||
a4e3ef55 | 14 | /* #define VERBOSE_DEBUG */ |
1da177e4 LT |
15 | |
16 | #include <linux/init.h> | |
17 | #include <linux/module.h> | |
18 | #include <linux/fs.h> | |
19 | #include <linux/pagemap.h> | |
20 | #include <linux/uts.h> | |
21 | #include <linux/wait.h> | |
22 | #include <linux/compiler.h> | |
7c0f6ba6 | 23 | #include <linux/uaccess.h> |
a99bbaf5 | 24 | #include <linux/sched.h> |
1da177e4 | 25 | #include <linux/slab.h> |
e22fc27c | 26 | #include <linux/poll.h> |
a80bf61e | 27 | #include <linux/mmu_context.h> |
4e179bca | 28 | #include <linux/aio.h> |
e2e40f2c | 29 | #include <linux/uio.h> |
b7ddc981 | 30 | #include <linux/refcount.h> |
1da177e4 LT |
31 | |
32 | #include <linux/device.h> | |
33 | #include <linux/moduleparam.h> | |
34 | ||
a5262dcf | 35 | #include <linux/usb/gadgetfs.h> |
9454a57a | 36 | #include <linux/usb/gadget.h> |
1da177e4 LT |
37 | |
38 | ||
39 | /* | |
40 | * The gadgetfs API maps each endpoint to a file descriptor so that you | |
41 | * can use standard synchronous read/write calls for I/O. There's some | |
42 | * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode | |
43 | * drivers show how this works in practice. You can also use AIO to | |
44 | * eliminate I/O gaps between requests, to help when streaming data. | |
45 | * | |
46 | * Key parts that must be USB-specific are protocols defining how the | |
47 | * read/write operations relate to the hardware state machines. There | |
48 | * are two types of files. One type is for the device, implementing ep0. | |
49 | * The other type is for each IN or OUT endpoint. In both cases, the | |
50 | * user mode driver must configure the hardware before using it. | |
51 | * | |
52 | * - First, dev_config() is called when /dev/gadget/$CHIP is configured | |
53 | * (by writing configuration and device descriptors). Afterwards it | |
54 | * may serve as a source of device events, used to handle all control | |
55 | * requests other than basic enumeration. | |
56 | * | |
511779fd PE |
57 | * - Then, after a SET_CONFIGURATION control request, ep_config() is |
58 | * called when each /dev/gadget/ep* file is configured (by writing | |
59 | * endpoint descriptors). Afterwards these files are used to write() | |
60 | * IN data or to read() OUT data. To halt the endpoint, a "wrong | |
61 | * direction" request is issued (like reading an IN endpoint). | |
1da177e4 LT |
62 | * |
63 | * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe | |
64 | * not possible on all hardware. For example, precise fault handling with | |
65 | * respect to data left in endpoint fifos after aborted operations; or | |
66 | * selective clearing of endpoint halts, to implement SET_INTERFACE. | |
67 | */ | |
68 | ||
69 | #define DRIVER_DESC "USB Gadget filesystem" | |
70 | #define DRIVER_VERSION "24 Aug 2004" | |
71 | ||
72 | static const char driver_desc [] = DRIVER_DESC; | |
73 | static const char shortname [] = "gadgetfs"; | |
74 | ||
75 | MODULE_DESCRIPTION (DRIVER_DESC); | |
76 | MODULE_AUTHOR ("David Brownell"); | |
77 | MODULE_LICENSE ("GPL"); | |
78 | ||
d4461a60 AV |
79 | static int ep_open(struct inode *, struct file *); |
80 | ||
1da177e4 LT |
81 | |
82 | /*----------------------------------------------------------------------*/ | |
83 | ||
84 | #define GADGETFS_MAGIC 0xaee71ee7 | |
1da177e4 LT |
85 | |
86 | /* /dev/gadget/$CHIP represents ep0 and the whole device */ | |
87 | enum ep0_state { | |
8a1115ff | 88 | /* DISABLED is the initial state. */ |
1da177e4 LT |
89 | STATE_DEV_DISABLED = 0, |
90 | ||
91 | /* Only one open() of /dev/gadget/$CHIP; only one file tracks | |
92 | * ep0/device i/o modes and binding to the controller. Driver | |
93 | * must always write descriptors to initialize the device, then | |
94 | * the device becomes UNCONNECTED until enumeration. | |
95 | */ | |
7489d149 | 96 | STATE_DEV_OPENED, |
1da177e4 LT |
97 | |
98 | /* From then on, ep0 fd is in either of two basic modes: | |
99 | * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it | |
100 | * - SETUP: read/write will transfer control data and succeed; | |
101 | * or if "wrong direction", performs protocol stall | |
102 | */ | |
7489d149 DB |
103 | STATE_DEV_UNCONNECTED, |
104 | STATE_DEV_CONNECTED, | |
105 | STATE_DEV_SETUP, | |
1da177e4 LT |
106 | |
107 | /* UNBOUND means the driver closed ep0, so the device won't be | |
108 | * accessible again (DEV_DISABLED) until all fds are closed. | |
109 | */ | |
110 | STATE_DEV_UNBOUND, | |
111 | }; | |
112 | ||
113 | /* enough for the whole queue: most events invalidate others */ | |
114 | #define N_EVENT 5 | |
115 | ||
116 | struct dev_data { | |
117 | spinlock_t lock; | |
b7ddc981 | 118 | refcount_t count; |
7489d149 | 119 | enum ep0_state state; /* P: lock */ |
1da177e4 LT |
120 | struct usb_gadgetfs_event event [N_EVENT]; |
121 | unsigned ev_next; | |
122 | struct fasync_struct *fasync; | |
123 | u8 current_config; | |
124 | ||
125 | /* drivers reading ep0 MUST handle control requests (SETUP) | |
126 | * reported that way; else the host will time out. | |
127 | */ | |
128 | unsigned usermode_setup : 1, | |
129 | setup_in : 1, | |
130 | setup_can_stall : 1, | |
131 | setup_out_ready : 1, | |
132 | setup_out_error : 1, | |
7b0a271d MS |
133 | setup_abort : 1, |
134 | gadget_registered : 1; | |
97906369 | 135 | unsigned setup_wLength; |
1da177e4 LT |
136 | |
137 | /* the rest is basically write-once */ | |
138 | struct usb_config_descriptor *config, *hs_config; | |
139 | struct usb_device_descriptor *dev; | |
140 | struct usb_request *req; | |
141 | struct usb_gadget *gadget; | |
142 | struct list_head epfiles; | |
143 | void *buf; | |
144 | wait_queue_head_t wait; | |
145 | struct super_block *sb; | |
146 | struct dentry *dentry; | |
147 | ||
148 | /* except this scratch i/o buffer for ep0 */ | |
149 | u8 rbuf [256]; | |
150 | }; | |
151 | ||
152 | static inline void get_dev (struct dev_data *data) | |
153 | { | |
b7ddc981 | 154 | refcount_inc (&data->count); |
1da177e4 LT |
155 | } |
156 | ||
157 | static void put_dev (struct dev_data *data) | |
158 | { | |
b7ddc981 | 159 | if (likely (!refcount_dec_and_test (&data->count))) |
1da177e4 LT |
160 | return; |
161 | /* needs no more cleanup */ | |
162 | BUG_ON (waitqueue_active (&data->wait)); | |
163 | kfree (data); | |
164 | } | |
165 | ||
166 | static struct dev_data *dev_new (void) | |
167 | { | |
168 | struct dev_data *dev; | |
169 | ||
7039f422 | 170 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); |
1da177e4 LT |
171 | if (!dev) |
172 | return NULL; | |
1da177e4 | 173 | dev->state = STATE_DEV_DISABLED; |
b7ddc981 | 174 | refcount_set (&dev->count, 1); |
1da177e4 LT |
175 | spin_lock_init (&dev->lock); |
176 | INIT_LIST_HEAD (&dev->epfiles); | |
177 | init_waitqueue_head (&dev->wait); | |
178 | return dev; | |
179 | } | |
180 | ||
181 | /*----------------------------------------------------------------------*/ | |
182 | ||
183 | /* other /dev/gadget/$ENDPOINT files represent endpoints */ | |
184 | enum ep_state { | |
185 | STATE_EP_DISABLED = 0, | |
186 | STATE_EP_READY, | |
1da177e4 LT |
187 | STATE_EP_ENABLED, |
188 | STATE_EP_UNBOUND, | |
189 | }; | |
190 | ||
191 | struct ep_data { | |
a79df50b | 192 | struct mutex lock; |
1da177e4 | 193 | enum ep_state state; |
8d66db50 | 194 | refcount_t count; |
1da177e4 LT |
195 | struct dev_data *dev; |
196 | /* must hold dev->lock before accessing ep or req */ | |
197 | struct usb_ep *ep; | |
198 | struct usb_request *req; | |
199 | ssize_t status; | |
200 | char name [16]; | |
201 | struct usb_endpoint_descriptor desc, hs_desc; | |
202 | struct list_head epfiles; | |
203 | wait_queue_head_t wait; | |
204 | struct dentry *dentry; | |
1da177e4 LT |
205 | }; |
206 | ||
207 | static inline void get_ep (struct ep_data *data) | |
208 | { | |
8d66db50 | 209 | refcount_inc (&data->count); |
1da177e4 LT |
210 | } |
211 | ||
212 | static void put_ep (struct ep_data *data) | |
213 | { | |
8d66db50 | 214 | if (likely (!refcount_dec_and_test (&data->count))) |
1da177e4 LT |
215 | return; |
216 | put_dev (data->dev); | |
217 | /* needs no more cleanup */ | |
218 | BUG_ON (!list_empty (&data->epfiles)); | |
219 | BUG_ON (waitqueue_active (&data->wait)); | |
1da177e4 LT |
220 | kfree (data); |
221 | } | |
222 | ||
223 | /*----------------------------------------------------------------------*/ | |
224 | ||
225 | /* most "how to use the hardware" policy choices are in userspace: | |
226 | * mapping endpoint roles (which the driver needs) to the capabilities | |
227 | * which the usb controller has. most of those capabilities are exposed | |
228 | * implicitly, starting with the driver name and then endpoint names. | |
229 | */ | |
230 | ||
231 | static const char *CHIP; | |
232 | ||
233 | /*----------------------------------------------------------------------*/ | |
234 | ||
235 | /* NOTE: don't use dev_printk calls before binding to the gadget | |
236 | * at the end of ep0 configuration, or after unbind. | |
237 | */ | |
238 | ||
239 | /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */ | |
240 | #define xprintk(d,level,fmt,args...) \ | |
241 | printk(level "%s: " fmt , shortname , ## args) | |
242 | ||
243 | #ifdef DEBUG | |
244 | #define DBG(dev,fmt,args...) \ | |
245 | xprintk(dev , KERN_DEBUG , fmt , ## args) | |
246 | #else | |
247 | #define DBG(dev,fmt,args...) \ | |
248 | do { } while (0) | |
249 | #endif /* DEBUG */ | |
250 | ||
a4e3ef55 | 251 | #ifdef VERBOSE_DEBUG |
1da177e4 LT |
252 | #define VDEBUG DBG |
253 | #else | |
254 | #define VDEBUG(dev,fmt,args...) \ | |
255 | do { } while (0) | |
256 | #endif /* DEBUG */ | |
257 | ||
258 | #define ERROR(dev,fmt,args...) \ | |
259 | xprintk(dev , KERN_ERR , fmt , ## args) | |
1da177e4 LT |
260 | #define INFO(dev,fmt,args...) \ |
261 | xprintk(dev , KERN_INFO , fmt , ## args) | |
262 | ||
263 | ||
264 | /*----------------------------------------------------------------------*/ | |
265 | ||
266 | /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso) | |
267 | * | |
268 | * After opening, configure non-control endpoints. Then use normal | |
269 | * stream read() and write() requests; and maybe ioctl() to get more | |
093cf723 | 270 | * precise FIFO status when recovering from cancellation. |
1da177e4 LT |
271 | */ |
272 | ||
273 | static void epio_complete (struct usb_ep *ep, struct usb_request *req) | |
274 | { | |
275 | struct ep_data *epdata = ep->driver_data; | |
276 | ||
277 | if (!req->context) | |
278 | return; | |
279 | if (req->status) | |
280 | epdata->status = req->status; | |
281 | else | |
282 | epdata->status = req->actual; | |
283 | complete ((struct completion *)req->context); | |
284 | } | |
285 | ||
286 | /* tasklock endpoint, returning when it's connected. | |
287 | * still need dev->lock to use epdata->ep. | |
288 | */ | |
289 | static int | |
d4461a60 | 290 | get_ready_ep (unsigned f_flags, struct ep_data *epdata, bool is_write) |
1da177e4 LT |
291 | { |
292 | int val; | |
293 | ||
294 | if (f_flags & O_NONBLOCK) { | |
a79df50b | 295 | if (!mutex_trylock(&epdata->lock)) |
1da177e4 | 296 | goto nonblock; |
d4461a60 AV |
297 | if (epdata->state != STATE_EP_ENABLED && |
298 | (!is_write || epdata->state != STATE_EP_READY)) { | |
a79df50b | 299 | mutex_unlock(&epdata->lock); |
1da177e4 LT |
300 | nonblock: |
301 | val = -EAGAIN; | |
302 | } else | |
303 | val = 0; | |
304 | return val; | |
305 | } | |
306 | ||
a79df50b TG |
307 | val = mutex_lock_interruptible(&epdata->lock); |
308 | if (val < 0) | |
1da177e4 | 309 | return val; |
511779fd | 310 | |
1da177e4 LT |
311 | switch (epdata->state) { |
312 | case STATE_EP_ENABLED: | |
d4461a60 AV |
313 | return 0; |
314 | case STATE_EP_READY: /* not configured yet */ | |
315 | if (is_write) | |
316 | return 0; | |
317 | // FALLTHRU | |
318 | case STATE_EP_UNBOUND: /* clean disconnect */ | |
1da177e4 | 319 | break; |
1da177e4 | 320 | // case STATE_EP_DISABLED: /* "can't happen" */ |
1da177e4 LT |
321 | default: /* error! */ |
322 | pr_debug ("%s: ep %p not available, state %d\n", | |
323 | shortname, epdata, epdata->state); | |
1da177e4 | 324 | } |
d4461a60 AV |
325 | mutex_unlock(&epdata->lock); |
326 | return -ENODEV; | |
1da177e4 LT |
327 | } |
328 | ||
329 | static ssize_t | |
330 | ep_io (struct ep_data *epdata, void *buf, unsigned len) | |
331 | { | |
6e9a4738 | 332 | DECLARE_COMPLETION_ONSTACK (done); |
1da177e4 LT |
333 | int value; |
334 | ||
335 | spin_lock_irq (&epdata->dev->lock); | |
336 | if (likely (epdata->ep != NULL)) { | |
337 | struct usb_request *req = epdata->req; | |
338 | ||
339 | req->context = &done; | |
340 | req->complete = epio_complete; | |
341 | req->buf = buf; | |
342 | req->length = len; | |
343 | value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC); | |
344 | } else | |
345 | value = -ENODEV; | |
346 | spin_unlock_irq (&epdata->dev->lock); | |
347 | ||
348 | if (likely (value == 0)) { | |
349 | value = wait_event_interruptible (done.wait, done.done); | |
350 | if (value != 0) { | |
351 | spin_lock_irq (&epdata->dev->lock); | |
352 | if (likely (epdata->ep != NULL)) { | |
353 | DBG (epdata->dev, "%s i/o interrupted\n", | |
354 | epdata->name); | |
355 | usb_ep_dequeue (epdata->ep, epdata->req); | |
356 | spin_unlock_irq (&epdata->dev->lock); | |
357 | ||
358 | wait_event (done.wait, done.done); | |
359 | if (epdata->status == -ECONNRESET) | |
360 | epdata->status = -EINTR; | |
361 | } else { | |
362 | spin_unlock_irq (&epdata->dev->lock); | |
363 | ||
364 | DBG (epdata->dev, "endpoint gone\n"); | |
365 | epdata->status = -ENODEV; | |
366 | } | |
367 | } | |
368 | return epdata->status; | |
369 | } | |
370 | return value; | |
371 | } | |
372 | ||
1da177e4 LT |
373 | static int |
374 | ep_release (struct inode *inode, struct file *fd) | |
375 | { | |
376 | struct ep_data *data = fd->private_data; | |
ba307f58 MS |
377 | int value; |
378 | ||
a79df50b TG |
379 | value = mutex_lock_interruptible(&data->lock); |
380 | if (value < 0) | |
ba307f58 | 381 | return value; |
1da177e4 LT |
382 | |
383 | /* clean up if this can be reopened */ | |
384 | if (data->state != STATE_EP_UNBOUND) { | |
385 | data->state = STATE_EP_DISABLED; | |
386 | data->desc.bDescriptorType = 0; | |
387 | data->hs_desc.bDescriptorType = 0; | |
4809ecc2 | 388 | usb_ep_disable(data->ep); |
1da177e4 | 389 | } |
a79df50b | 390 | mutex_unlock(&data->lock); |
1da177e4 LT |
391 | put_ep (data); |
392 | return 0; | |
393 | } | |
394 | ||
44c389a0 | 395 | static long ep_ioctl(struct file *fd, unsigned code, unsigned long value) |
1da177e4 LT |
396 | { |
397 | struct ep_data *data = fd->private_data; | |
398 | int status; | |
399 | ||
d4461a60 | 400 | if ((status = get_ready_ep (fd->f_flags, data, false)) < 0) |
1da177e4 LT |
401 | return status; |
402 | ||
403 | spin_lock_irq (&data->dev->lock); | |
404 | if (likely (data->ep != NULL)) { | |
405 | switch (code) { | |
406 | case GADGETFS_FIFO_STATUS: | |
407 | status = usb_ep_fifo_status (data->ep); | |
408 | break; | |
409 | case GADGETFS_FIFO_FLUSH: | |
410 | usb_ep_fifo_flush (data->ep); | |
411 | break; | |
412 | case GADGETFS_CLEAR_HALT: | |
413 | status = usb_ep_clear_halt (data->ep); | |
414 | break; | |
415 | default: | |
416 | status = -ENOTTY; | |
417 | } | |
418 | } else | |
419 | status = -ENODEV; | |
420 | spin_unlock_irq (&data->dev->lock); | |
a79df50b | 421 | mutex_unlock(&data->lock); |
1da177e4 LT |
422 | return status; |
423 | } | |
424 | ||
425 | /*----------------------------------------------------------------------*/ | |
426 | ||
427 | /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */ | |
428 | ||
429 | struct kiocb_priv { | |
430 | struct usb_request *req; | |
431 | struct ep_data *epdata; | |
a80bf61e ZB |
432 | struct kiocb *iocb; |
433 | struct mm_struct *mm; | |
434 | struct work_struct work; | |
1da177e4 | 435 | void *buf; |
7fe3976e AV |
436 | struct iov_iter to; |
437 | const void *to_free; | |
1da177e4 LT |
438 | unsigned actual; |
439 | }; | |
440 | ||
bec68faa | 441 | static int ep_aio_cancel(struct kiocb *iocb) |
1da177e4 LT |
442 | { |
443 | struct kiocb_priv *priv = iocb->private; | |
444 | struct ep_data *epdata; | |
445 | int value; | |
446 | ||
447 | local_irq_disable(); | |
448 | epdata = priv->epdata; | |
449 | // spin_lock(&epdata->dev->lock); | |
1da177e4 LT |
450 | if (likely(epdata && epdata->ep && priv->req)) |
451 | value = usb_ep_dequeue (epdata->ep, priv->req); | |
452 | else | |
453 | value = -EINVAL; | |
454 | // spin_unlock(&epdata->dev->lock); | |
455 | local_irq_enable(); | |
456 | ||
1da177e4 LT |
457 | return value; |
458 | } | |
459 | ||
a80bf61e ZB |
460 | static void ep_user_copy_worker(struct work_struct *work) |
461 | { | |
462 | struct kiocb_priv *priv = container_of(work, struct kiocb_priv, work); | |
463 | struct mm_struct *mm = priv->mm; | |
464 | struct kiocb *iocb = priv->iocb; | |
465 | size_t ret; | |
466 | ||
467 | use_mm(mm); | |
7fe3976e | 468 | ret = copy_to_iter(priv->buf, priv->actual, &priv->to); |
a80bf61e | 469 | unuse_mm(mm); |
7fe3976e AV |
470 | if (!ret) |
471 | ret = -EFAULT; | |
a80bf61e ZB |
472 | |
473 | /* completing the iocb can drop the ctx and mm, don't touch mm after */ | |
04b2fa9f | 474 | iocb->ki_complete(iocb, ret, ret); |
a80bf61e | 475 | |
2505107d | 476 | kfree(priv->buf); |
7fe3976e | 477 | kfree(priv->to_free); |
2505107d | 478 | kfree(priv); |
1da177e4 LT |
479 | } |
480 | ||
481 | static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req) | |
482 | { | |
483 | struct kiocb *iocb = req->context; | |
484 | struct kiocb_priv *priv = iocb->private; | |
485 | struct ep_data *epdata = priv->epdata; | |
486 | ||
487 | /* lock against disconnect (and ideally, cancel) */ | |
488 | spin_lock(&epdata->dev->lock); | |
489 | priv->req = NULL; | |
490 | priv->epdata = NULL; | |
49631ca7 AS |
491 | |
492 | /* if this was a write or a read returning no data then we | |
493 | * don't need to copy anything to userspace, so we can | |
494 | * complete the aio request immediately. | |
495 | */ | |
7fe3976e | 496 | if (priv->to_free == NULL || unlikely(req->actual == 0)) { |
1da177e4 | 497 | kfree(req->buf); |
7fe3976e | 498 | kfree(priv->to_free); |
1da177e4 LT |
499 | kfree(priv); |
500 | iocb->private = NULL; | |
501 | /* aio_complete() reports bytes-transferred _and_ faults */ | |
04b2fa9f CH |
502 | |
503 | iocb->ki_complete(iocb, req->actual ? req->actual : req->status, | |
1da177e4 LT |
504 | req->status); |
505 | } else { | |
a80bf61e | 506 | /* ep_copy_to_user() won't report both; we hide some faults */ |
1da177e4 LT |
507 | if (unlikely(0 != req->status)) |
508 | DBG(epdata->dev, "%s fault %d len %d\n", | |
509 | ep->name, req->status, req->actual); | |
510 | ||
511 | priv->buf = req->buf; | |
512 | priv->actual = req->actual; | |
7fe3976e | 513 | INIT_WORK(&priv->work, ep_user_copy_worker); |
a80bf61e | 514 | schedule_work(&priv->work); |
1da177e4 LT |
515 | } |
516 | spin_unlock(&epdata->dev->lock); | |
517 | ||
518 | usb_ep_free_request(ep, req); | |
519 | put_ep(epdata); | |
520 | } | |
521 | ||
7fe3976e AV |
522 | static ssize_t ep_aio(struct kiocb *iocb, |
523 | struct kiocb_priv *priv, | |
524 | struct ep_data *epdata, | |
525 | char *buf, | |
526 | size_t len) | |
1da177e4 | 527 | { |
7fe3976e AV |
528 | struct usb_request *req; |
529 | ssize_t value; | |
1da177e4 | 530 | |
1da177e4 | 531 | iocb->private = priv; |
a80bf61e | 532 | priv->iocb = iocb; |
1da177e4 | 533 | |
0460fef2 | 534 | kiocb_set_cancel_fn(iocb, ep_aio_cancel); |
1da177e4 LT |
535 | get_ep(epdata); |
536 | priv->epdata = epdata; | |
537 | priv->actual = 0; | |
a80bf61e | 538 | priv->mm = current->mm; /* mm teardown waits for iocbs in exit_aio() */ |
1da177e4 LT |
539 | |
540 | /* each kiocb is coupled to one usb_request, but we can't | |
541 | * allocate or submit those if the host disconnected. | |
542 | */ | |
543 | spin_lock_irq(&epdata->dev->lock); | |
7fe3976e | 544 | value = -ENODEV; |
327b21da | 545 | if (unlikely(epdata->ep == NULL)) |
7fe3976e | 546 | goto fail; |
1da177e4 | 547 | |
7fe3976e AV |
548 | req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC); |
549 | value = -ENOMEM; | |
550 | if (unlikely(!req)) | |
551 | goto fail; | |
1da177e4 | 552 | |
7fe3976e AV |
553 | priv->req = req; |
554 | req->buf = buf; | |
555 | req->length = len; | |
556 | req->complete = ep_aio_complete; | |
557 | req->context = iocb; | |
558 | value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC); | |
559 | if (unlikely(0 != value)) { | |
560 | usb_ep_free_request(epdata->ep, req); | |
561 | goto fail; | |
562 | } | |
563 | spin_unlock_irq(&epdata->dev->lock); | |
564 | return -EIOCBQUEUED; | |
565 | ||
566 | fail: | |
567 | spin_unlock_irq(&epdata->dev->lock); | |
568 | kfree(priv->to_free); | |
569 | kfree(priv); | |
570 | put_ep(epdata); | |
1da177e4 LT |
571 | return value; |
572 | } | |
573 | ||
574 | static ssize_t | |
7fe3976e | 575 | ep_read_iter(struct kiocb *iocb, struct iov_iter *to) |
1da177e4 | 576 | { |
7fe3976e AV |
577 | struct file *file = iocb->ki_filp; |
578 | struct ep_data *epdata = file->private_data; | |
579 | size_t len = iov_iter_count(to); | |
580 | ssize_t value; | |
581 | char *buf; | |
1da177e4 | 582 | |
d4461a60 | 583 | if ((value = get_ready_ep(file->f_flags, epdata, false)) < 0) |
7fe3976e | 584 | return value; |
027445c3 | 585 | |
7fe3976e AV |
586 | /* halt any endpoint by doing a "wrong direction" i/o call */ |
587 | if (usb_endpoint_dir_in(&epdata->desc)) { | |
588 | if (usb_endpoint_xfer_isoc(&epdata->desc) || | |
589 | !is_sync_kiocb(iocb)) { | |
590 | mutex_unlock(&epdata->lock); | |
591 | return -EINVAL; | |
592 | } | |
593 | DBG (epdata->dev, "%s halt\n", epdata->name); | |
594 | spin_lock_irq(&epdata->dev->lock); | |
595 | if (likely(epdata->ep != NULL)) | |
596 | usb_ep_set_halt(epdata->ep); | |
597 | spin_unlock_irq(&epdata->dev->lock); | |
598 | mutex_unlock(&epdata->lock); | |
599 | return -EBADMSG; | |
600 | } | |
027445c3 | 601 | |
7fe3976e AV |
602 | buf = kmalloc(len, GFP_KERNEL); |
603 | if (unlikely(!buf)) { | |
604 | mutex_unlock(&epdata->lock); | |
605 | return -ENOMEM; | |
606 | } | |
607 | if (is_sync_kiocb(iocb)) { | |
608 | value = ep_io(epdata, buf, len); | |
63196e98 | 609 | if (value >= 0 && (copy_to_iter(buf, value, to) != value)) |
7fe3976e AV |
610 | value = -EFAULT; |
611 | } else { | |
612 | struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL); | |
613 | value = -ENOMEM; | |
614 | if (!priv) | |
615 | goto fail; | |
616 | priv->to_free = dup_iter(&priv->to, to, GFP_KERNEL); | |
617 | if (!priv->to_free) { | |
618 | kfree(priv); | |
619 | goto fail; | |
620 | } | |
621 | value = ep_aio(iocb, priv, epdata, buf, len); | |
622 | if (value == -EIOCBQUEUED) | |
623 | buf = NULL; | |
624 | } | |
625 | fail: | |
626 | kfree(buf); | |
627 | mutex_unlock(&epdata->lock); | |
628 | return value; | |
1da177e4 LT |
629 | } |
630 | ||
d4461a60 AV |
631 | static ssize_t ep_config(struct ep_data *, const char *, size_t); |
632 | ||
1da177e4 | 633 | static ssize_t |
7fe3976e | 634 | ep_write_iter(struct kiocb *iocb, struct iov_iter *from) |
1da177e4 | 635 | { |
7fe3976e AV |
636 | struct file *file = iocb->ki_filp; |
637 | struct ep_data *epdata = file->private_data; | |
638 | size_t len = iov_iter_count(from); | |
d4461a60 | 639 | bool configured; |
7fe3976e AV |
640 | ssize_t value; |
641 | char *buf; | |
1da177e4 | 642 | |
d4461a60 | 643 | if ((value = get_ready_ep(file->f_flags, epdata, true)) < 0) |
7fe3976e AV |
644 | return value; |
645 | ||
d4461a60 AV |
646 | configured = epdata->state == STATE_EP_ENABLED; |
647 | ||
7fe3976e | 648 | /* halt any endpoint by doing a "wrong direction" i/o call */ |
d4461a60 | 649 | if (configured && !usb_endpoint_dir_in(&epdata->desc)) { |
7fe3976e AV |
650 | if (usb_endpoint_xfer_isoc(&epdata->desc) || |
651 | !is_sync_kiocb(iocb)) { | |
652 | mutex_unlock(&epdata->lock); | |
653 | return -EINVAL; | |
654 | } | |
655 | DBG (epdata->dev, "%s halt\n", epdata->name); | |
656 | spin_lock_irq(&epdata->dev->lock); | |
657 | if (likely(epdata->ep != NULL)) | |
658 | usb_ep_set_halt(epdata->ep); | |
659 | spin_unlock_irq(&epdata->dev->lock); | |
660 | mutex_unlock(&epdata->lock); | |
661 | return -EBADMSG; | |
662 | } | |
027445c3 | 663 | |
7fe3976e AV |
664 | buf = kmalloc(len, GFP_KERNEL); |
665 | if (unlikely(!buf)) { | |
666 | mutex_unlock(&epdata->lock); | |
1da177e4 | 667 | return -ENOMEM; |
7fe3976e | 668 | } |
027445c3 | 669 | |
cbbd26b8 | 670 | if (unlikely(!copy_from_iter_full(buf, len, from))) { |
7fe3976e AV |
671 | value = -EFAULT; |
672 | goto out; | |
673 | } | |
674 | ||
d4461a60 AV |
675 | if (unlikely(!configured)) { |
676 | value = ep_config(epdata, buf, len); | |
677 | } else if (is_sync_kiocb(iocb)) { | |
7fe3976e AV |
678 | value = ep_io(epdata, buf, len); |
679 | } else { | |
680 | struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL); | |
681 | value = -ENOMEM; | |
682 | if (priv) { | |
683 | value = ep_aio(iocb, priv, epdata, buf, len); | |
684 | if (value == -EIOCBQUEUED) | |
685 | buf = NULL; | |
027445c3 | 686 | } |
1da177e4 | 687 | } |
7fe3976e AV |
688 | out: |
689 | kfree(buf); | |
690 | mutex_unlock(&epdata->lock); | |
691 | return value; | |
1da177e4 LT |
692 | } |
693 | ||
694 | /*----------------------------------------------------------------------*/ | |
695 | ||
696 | /* used after endpoint configuration */ | |
066202dd | 697 | static const struct file_operations ep_io_operations = { |
1da177e4 | 698 | .owner = THIS_MODULE, |
1da177e4 | 699 | |
d4461a60 AV |
700 | .open = ep_open, |
701 | .release = ep_release, | |
702 | .llseek = no_llseek, | |
44c389a0 | 703 | .unlocked_ioctl = ep_ioctl, |
7fe3976e AV |
704 | .read_iter = ep_read_iter, |
705 | .write_iter = ep_write_iter, | |
1da177e4 LT |
706 | }; |
707 | ||
708 | /* ENDPOINT INITIALIZATION | |
709 | * | |
710 | * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR) | |
711 | * status = write (fd, descriptors, sizeof descriptors) | |
712 | * | |
713 | * That write establishes the endpoint configuration, configuring | |
714 | * the controller to process bulk, interrupt, or isochronous transfers | |
715 | * at the right maxpacket size, and so on. | |
716 | * | |
717 | * The descriptors are message type 1, identified by a host order u32 | |
718 | * at the beginning of what's written. Descriptor order is: full/low | |
719 | * speed descriptor, then optional high speed descriptor. | |
720 | */ | |
721 | static ssize_t | |
d4461a60 | 722 | ep_config (struct ep_data *data, const char *buf, size_t len) |
1da177e4 | 723 | { |
1da177e4 LT |
724 | struct usb_ep *ep; |
725 | u32 tag; | |
8a7471ab | 726 | int value, length = len; |
1da177e4 | 727 | |
1da177e4 LT |
728 | if (data->state != STATE_EP_READY) { |
729 | value = -EL2HLT; | |
730 | goto fail; | |
731 | } | |
732 | ||
733 | value = len; | |
734 | if (len < USB_DT_ENDPOINT_SIZE + 4) | |
735 | goto fail0; | |
736 | ||
737 | /* we might need to change message format someday */ | |
d4461a60 | 738 | memcpy(&tag, buf, 4); |
1da177e4 LT |
739 | if (tag != 1) { |
740 | DBG(data->dev, "config %s, bad tag %d\n", data->name, tag); | |
741 | goto fail0; | |
742 | } | |
743 | buf += 4; | |
744 | len -= 4; | |
745 | ||
746 | /* NOTE: audio endpoint extensions not accepted here; | |
747 | * just don't include the extra bytes. | |
748 | */ | |
749 | ||
750 | /* full/low speed descriptor, then high speed */ | |
d4461a60 | 751 | memcpy(&data->desc, buf, USB_DT_ENDPOINT_SIZE); |
1da177e4 LT |
752 | if (data->desc.bLength != USB_DT_ENDPOINT_SIZE |
753 | || data->desc.bDescriptorType != USB_DT_ENDPOINT) | |
754 | goto fail0; | |
755 | if (len != USB_DT_ENDPOINT_SIZE) { | |
756 | if (len != 2 * USB_DT_ENDPOINT_SIZE) | |
757 | goto fail0; | |
d4461a60 AV |
758 | memcpy(&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE, |
759 | USB_DT_ENDPOINT_SIZE); | |
1da177e4 LT |
760 | if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE |
761 | || data->hs_desc.bDescriptorType | |
762 | != USB_DT_ENDPOINT) { | |
763 | DBG(data->dev, "config %s, bad hs length or type\n", | |
764 | data->name); | |
765 | goto fail0; | |
766 | } | |
767 | } | |
1da177e4 LT |
768 | |
769 | spin_lock_irq (&data->dev->lock); | |
770 | if (data->dev->state == STATE_DEV_UNBOUND) { | |
771 | value = -ENOENT; | |
772 | goto gone; | |
1ee7eead GKH |
773 | } else { |
774 | ep = data->ep; | |
775 | if (ep == NULL) { | |
776 | value = -ENODEV; | |
777 | goto gone; | |
778 | } | |
1da177e4 LT |
779 | } |
780 | switch (data->dev->gadget->speed) { | |
781 | case USB_SPEED_LOW: | |
782 | case USB_SPEED_FULL: | |
72c973dd | 783 | ep->desc = &data->desc; |
1da177e4 | 784 | break; |
1da177e4 LT |
785 | case USB_SPEED_HIGH: |
786 | /* fails if caller didn't provide that descriptor... */ | |
72c973dd | 787 | ep->desc = &data->hs_desc; |
1da177e4 | 788 | break; |
1da177e4 | 789 | default: |
511779fd | 790 | DBG(data->dev, "unconnected, %s init abandoned\n", |
1da177e4 | 791 | data->name); |
511779fd | 792 | value = -EINVAL; |
d4461a60 | 793 | goto gone; |
1da177e4 | 794 | } |
d4461a60 | 795 | value = usb_ep_enable(ep); |
8a7471ab | 796 | if (value == 0) { |
d4461a60 | 797 | data->state = STATE_EP_ENABLED; |
8a7471ab MS |
798 | value = length; |
799 | } | |
1da177e4 LT |
800 | gone: |
801 | spin_unlock_irq (&data->dev->lock); | |
802 | if (value < 0) { | |
803 | fail: | |
804 | data->desc.bDescriptorType = 0; | |
805 | data->hs_desc.bDescriptorType = 0; | |
806 | } | |
1da177e4 LT |
807 | return value; |
808 | fail0: | |
809 | value = -EINVAL; | |
810 | goto fail; | |
1da177e4 LT |
811 | } |
812 | ||
813 | static int | |
814 | ep_open (struct inode *inode, struct file *fd) | |
815 | { | |
8e18e294 | 816 | struct ep_data *data = inode->i_private; |
1da177e4 LT |
817 | int value = -EBUSY; |
818 | ||
a79df50b | 819 | if (mutex_lock_interruptible(&data->lock) != 0) |
1da177e4 LT |
820 | return -EINTR; |
821 | spin_lock_irq (&data->dev->lock); | |
822 | if (data->dev->state == STATE_DEV_UNBOUND) | |
823 | value = -ENOENT; | |
824 | else if (data->state == STATE_EP_DISABLED) { | |
825 | value = 0; | |
826 | data->state = STATE_EP_READY; | |
827 | get_ep (data); | |
828 | fd->private_data = data; | |
829 | VDEBUG (data->dev, "%s ready\n", data->name); | |
830 | } else | |
831 | DBG (data->dev, "%s state %d\n", | |
832 | data->name, data->state); | |
833 | spin_unlock_irq (&data->dev->lock); | |
a79df50b | 834 | mutex_unlock(&data->lock); |
1da177e4 LT |
835 | return value; |
836 | } | |
837 | ||
1da177e4 LT |
838 | /*----------------------------------------------------------------------*/ |
839 | ||
840 | /* EP0 IMPLEMENTATION can be partly in userspace. | |
841 | * | |
842 | * Drivers that use this facility receive various events, including | |
843 | * control requests the kernel doesn't handle. Drivers that don't | |
844 | * use this facility may be too simple-minded for real applications. | |
845 | */ | |
846 | ||
847 | static inline void ep0_readable (struct dev_data *dev) | |
848 | { | |
849 | wake_up (&dev->wait); | |
850 | kill_fasync (&dev->fasync, SIGIO, POLL_IN); | |
851 | } | |
852 | ||
853 | static void clean_req (struct usb_ep *ep, struct usb_request *req) | |
854 | { | |
855 | struct dev_data *dev = ep->driver_data; | |
856 | ||
857 | if (req->buf != dev->rbuf) { | |
9d8bab58 | 858 | kfree(req->buf); |
1da177e4 | 859 | req->buf = dev->rbuf; |
1da177e4 LT |
860 | } |
861 | req->complete = epio_complete; | |
862 | dev->setup_out_ready = 0; | |
863 | } | |
864 | ||
865 | static void ep0_complete (struct usb_ep *ep, struct usb_request *req) | |
866 | { | |
867 | struct dev_data *dev = ep->driver_data; | |
5b89db02 | 868 | unsigned long flags; |
1da177e4 LT |
869 | int free = 1; |
870 | ||
871 | /* for control OUT, data must still get to userspace */ | |
5b89db02 | 872 | spin_lock_irqsave(&dev->lock, flags); |
1da177e4 LT |
873 | if (!dev->setup_in) { |
874 | dev->setup_out_error = (req->status != 0); | |
875 | if (!dev->setup_out_error) | |
876 | free = 0; | |
877 | dev->setup_out_ready = 1; | |
878 | ep0_readable (dev); | |
7489d149 | 879 | } |
1da177e4 LT |
880 | |
881 | /* clean up as appropriate */ | |
882 | if (free && req->buf != &dev->rbuf) | |
883 | clean_req (ep, req); | |
884 | req->complete = epio_complete; | |
5b89db02 | 885 | spin_unlock_irqrestore(&dev->lock, flags); |
1da177e4 LT |
886 | } |
887 | ||
888 | static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len) | |
889 | { | |
890 | struct dev_data *dev = ep->driver_data; | |
891 | ||
892 | if (dev->setup_out_ready) { | |
893 | DBG (dev, "ep0 request busy!\n"); | |
894 | return -EBUSY; | |
895 | } | |
896 | if (len > sizeof (dev->rbuf)) | |
9d8bab58 | 897 | req->buf = kmalloc(len, GFP_ATOMIC); |
a9475226 | 898 | if (req->buf == NULL) { |
1da177e4 LT |
899 | req->buf = dev->rbuf; |
900 | return -ENOMEM; | |
901 | } | |
902 | req->complete = ep0_complete; | |
903 | req->length = len; | |
97906369 | 904 | req->zero = 0; |
1da177e4 LT |
905 | return 0; |
906 | } | |
907 | ||
908 | static ssize_t | |
909 | ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr) | |
910 | { | |
911 | struct dev_data *dev = fd->private_data; | |
912 | ssize_t retval; | |
913 | enum ep0_state state; | |
914 | ||
915 | spin_lock_irq (&dev->lock); | |
96b62a57 AS |
916 | if (dev->state <= STATE_DEV_OPENED) { |
917 | retval = -EINVAL; | |
918 | goto done; | |
919 | } | |
1da177e4 LT |
920 | |
921 | /* report fd mode change before acting on it */ | |
922 | if (dev->setup_abort) { | |
923 | dev->setup_abort = 0; | |
924 | retval = -EIDRM; | |
925 | goto done; | |
926 | } | |
927 | ||
928 | /* control DATA stage */ | |
7489d149 | 929 | if ((state = dev->state) == STATE_DEV_SETUP) { |
1da177e4 LT |
930 | |
931 | if (dev->setup_in) { /* stall IN */ | |
932 | VDEBUG(dev, "ep0in stall\n"); | |
933 | (void) usb_ep_set_halt (dev->gadget->ep0); | |
934 | retval = -EL2HLT; | |
7489d149 | 935 | dev->state = STATE_DEV_CONNECTED; |
1da177e4 LT |
936 | |
937 | } else if (len == 0) { /* ack SET_CONFIGURATION etc */ | |
938 | struct usb_ep *ep = dev->gadget->ep0; | |
939 | struct usb_request *req = dev->req; | |
940 | ||
d246dcb2 BL |
941 | if ((retval = setup_req (ep, req, 0)) == 0) { |
942 | spin_unlock_irq (&dev->lock); | |
943 | retval = usb_ep_queue (ep, req, GFP_KERNEL); | |
944 | spin_lock_irq (&dev->lock); | |
945 | } | |
7489d149 | 946 | dev->state = STATE_DEV_CONNECTED; |
1da177e4 LT |
947 | |
948 | /* assume that was SET_CONFIGURATION */ | |
949 | if (dev->current_config) { | |
950 | unsigned power; | |
a4e3ef55 DB |
951 | |
952 | if (gadget_is_dualspeed(dev->gadget) | |
953 | && (dev->gadget->speed | |
954 | == USB_SPEED_HIGH)) | |
1da177e4 LT |
955 | power = dev->hs_config->bMaxPower; |
956 | else | |
1da177e4 LT |
957 | power = dev->config->bMaxPower; |
958 | usb_gadget_vbus_draw(dev->gadget, 2 * power); | |
959 | } | |
960 | ||
961 | } else { /* collect OUT data */ | |
962 | if ((fd->f_flags & O_NONBLOCK) != 0 | |
963 | && !dev->setup_out_ready) { | |
964 | retval = -EAGAIN; | |
965 | goto done; | |
966 | } | |
967 | spin_unlock_irq (&dev->lock); | |
968 | retval = wait_event_interruptible (dev->wait, | |
969 | dev->setup_out_ready != 0); | |
970 | ||
971 | /* FIXME state could change from under us */ | |
972 | spin_lock_irq (&dev->lock); | |
973 | if (retval) | |
974 | goto done; | |
5b89db02 DB |
975 | |
976 | if (dev->state != STATE_DEV_SETUP) { | |
977 | retval = -ECANCELED; | |
978 | goto done; | |
979 | } | |
980 | dev->state = STATE_DEV_CONNECTED; | |
981 | ||
1da177e4 LT |
982 | if (dev->setup_out_error) |
983 | retval = -EIO; | |
984 | else { | |
985 | len = min (len, (size_t)dev->req->actual); | |
986 | // FIXME don't call this with the spinlock held ... | |
997694de | 987 | if (copy_to_user (buf, dev->req->buf, len)) |
1da177e4 | 988 | retval = -EFAULT; |
85b4b3c8 TF |
989 | else |
990 | retval = len; | |
1da177e4 LT |
991 | clean_req (dev->gadget->ep0, dev->req); |
992 | /* NOTE userspace can't yet choose to stall */ | |
993 | } | |
994 | } | |
995 | goto done; | |
996 | } | |
997 | ||
998 | /* else normal: return event data */ | |
999 | if (len < sizeof dev->event [0]) { | |
1000 | retval = -EINVAL; | |
1001 | goto done; | |
1002 | } | |
1003 | len -= len % sizeof (struct usb_gadgetfs_event); | |
1004 | dev->usermode_setup = 1; | |
1005 | ||
1006 | scan: | |
1007 | /* return queued events right away */ | |
1008 | if (dev->ev_next != 0) { | |
1009 | unsigned i, n; | |
1da177e4 | 1010 | |
1da177e4 | 1011 | n = len / sizeof (struct usb_gadgetfs_event); |
0864c7a9 DB |
1012 | if (dev->ev_next < n) |
1013 | n = dev->ev_next; | |
1da177e4 | 1014 | |
0864c7a9 | 1015 | /* ep0 i/o has special semantics during STATE_DEV_SETUP */ |
1da177e4 LT |
1016 | for (i = 0; i < n; i++) { |
1017 | if (dev->event [i].type == GADGETFS_SETUP) { | |
0864c7a9 DB |
1018 | dev->state = STATE_DEV_SETUP; |
1019 | n = i + 1; | |
1da177e4 LT |
1020 | break; |
1021 | } | |
1022 | } | |
1023 | spin_unlock_irq (&dev->lock); | |
0864c7a9 | 1024 | len = n * sizeof (struct usb_gadgetfs_event); |
1da177e4 LT |
1025 | if (copy_to_user (buf, &dev->event, len)) |
1026 | retval = -EFAULT; | |
1027 | else | |
1028 | retval = len; | |
1029 | if (len > 0) { | |
1da177e4 LT |
1030 | /* NOTE this doesn't guard against broken drivers; |
1031 | * concurrent ep0 readers may lose events. | |
1032 | */ | |
1033 | spin_lock_irq (&dev->lock); | |
0864c7a9 DB |
1034 | if (dev->ev_next > n) { |
1035 | memmove(&dev->event[0], &dev->event[n], | |
1da177e4 | 1036 | sizeof (struct usb_gadgetfs_event) |
0864c7a9 DB |
1037 | * (dev->ev_next - n)); |
1038 | } | |
1039 | dev->ev_next -= n; | |
1da177e4 LT |
1040 | spin_unlock_irq (&dev->lock); |
1041 | } | |
1042 | return retval; | |
1043 | } | |
1044 | if (fd->f_flags & O_NONBLOCK) { | |
1045 | retval = -EAGAIN; | |
1046 | goto done; | |
1047 | } | |
1048 | ||
1049 | switch (state) { | |
1050 | default: | |
441b62c1 | 1051 | DBG (dev, "fail %s, state %d\n", __func__, state); |
1da177e4 LT |
1052 | retval = -ESRCH; |
1053 | break; | |
7489d149 DB |
1054 | case STATE_DEV_UNCONNECTED: |
1055 | case STATE_DEV_CONNECTED: | |
1da177e4 | 1056 | spin_unlock_irq (&dev->lock); |
441b62c1 | 1057 | DBG (dev, "%s wait\n", __func__); |
1da177e4 LT |
1058 | |
1059 | /* wait for events */ | |
1060 | retval = wait_event_interruptible (dev->wait, | |
1061 | dev->ev_next != 0); | |
1062 | if (retval < 0) | |
1063 | return retval; | |
1064 | spin_lock_irq (&dev->lock); | |
1065 | goto scan; | |
1066 | } | |
1067 | ||
1068 | done: | |
1069 | spin_unlock_irq (&dev->lock); | |
1070 | return retval; | |
1071 | } | |
1072 | ||
1073 | static struct usb_gadgetfs_event * | |
1074 | next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type) | |
1075 | { | |
1076 | struct usb_gadgetfs_event *event; | |
1077 | unsigned i; | |
1078 | ||
1079 | switch (type) { | |
1080 | /* these events purge the queue */ | |
1081 | case GADGETFS_DISCONNECT: | |
7489d149 | 1082 | if (dev->state == STATE_DEV_SETUP) |
1da177e4 LT |
1083 | dev->setup_abort = 1; |
1084 | // FALL THROUGH | |
1085 | case GADGETFS_CONNECT: | |
1086 | dev->ev_next = 0; | |
1087 | break; | |
1088 | case GADGETFS_SETUP: /* previous request timed out */ | |
1089 | case GADGETFS_SUSPEND: /* same effect */ | |
1090 | /* these events can't be repeated */ | |
1091 | for (i = 0; i != dev->ev_next; i++) { | |
1092 | if (dev->event [i].type != type) | |
1093 | continue; | |
0864c7a9 | 1094 | DBG(dev, "discard old event[%d] %d\n", i, type); |
1da177e4 LT |
1095 | dev->ev_next--; |
1096 | if (i == dev->ev_next) | |
1097 | break; | |
1098 | /* indices start at zero, for simplicity */ | |
1099 | memmove (&dev->event [i], &dev->event [i + 1], | |
1100 | sizeof (struct usb_gadgetfs_event) | |
1101 | * (dev->ev_next - i)); | |
1102 | } | |
1103 | break; | |
1104 | default: | |
1105 | BUG (); | |
1106 | } | |
0864c7a9 | 1107 | VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type); |
1da177e4 LT |
1108 | event = &dev->event [dev->ev_next++]; |
1109 | BUG_ON (dev->ev_next > N_EVENT); | |
1da177e4 LT |
1110 | memset (event, 0, sizeof *event); |
1111 | event->type = type; | |
1112 | return event; | |
1113 | } | |
1114 | ||
1115 | static ssize_t | |
1116 | ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr) | |
1117 | { | |
1118 | struct dev_data *dev = fd->private_data; | |
1119 | ssize_t retval = -ESRCH; | |
1120 | ||
1da177e4 LT |
1121 | /* report fd mode change before acting on it */ |
1122 | if (dev->setup_abort) { | |
1123 | dev->setup_abort = 0; | |
1124 | retval = -EIDRM; | |
1125 | ||
1126 | /* data and/or status stage for control request */ | |
7489d149 | 1127 | } else if (dev->state == STATE_DEV_SETUP) { |
1da177e4 | 1128 | |
faab5098 | 1129 | len = min_t(size_t, len, dev->setup_wLength); |
1da177e4 LT |
1130 | if (dev->setup_in) { |
1131 | retval = setup_req (dev->gadget->ep0, dev->req, len); | |
1132 | if (retval == 0) { | |
5b89db02 | 1133 | dev->state = STATE_DEV_CONNECTED; |
1da177e4 LT |
1134 | spin_unlock_irq (&dev->lock); |
1135 | if (copy_from_user (dev->req->buf, buf, len)) | |
1136 | retval = -EFAULT; | |
97906369 AS |
1137 | else { |
1138 | if (len < dev->setup_wLength) | |
1139 | dev->req->zero = 1; | |
1da177e4 LT |
1140 | retval = usb_ep_queue ( |
1141 | dev->gadget->ep0, dev->req, | |
1142 | GFP_KERNEL); | |
97906369 | 1143 | } |
b7bd98b7 | 1144 | spin_lock_irq(&dev->lock); |
1da177e4 | 1145 | if (retval < 0) { |
1da177e4 | 1146 | clean_req (dev->gadget->ep0, dev->req); |
1da177e4 LT |
1147 | } else |
1148 | retval = len; | |
1149 | ||
1150 | return retval; | |
1151 | } | |
1152 | ||
1153 | /* can stall some OUT transfers */ | |
1154 | } else if (dev->setup_can_stall) { | |
1155 | VDEBUG(dev, "ep0out stall\n"); | |
1156 | (void) usb_ep_set_halt (dev->gadget->ep0); | |
1157 | retval = -EL2HLT; | |
7489d149 | 1158 | dev->state = STATE_DEV_CONNECTED; |
1da177e4 LT |
1159 | } else { |
1160 | DBG(dev, "bogus ep0out stall!\n"); | |
1161 | } | |
1162 | } else | |
441b62c1 | 1163 | DBG (dev, "fail %s, state %d\n", __func__, dev->state); |
1da177e4 | 1164 | |
1da177e4 LT |
1165 | return retval; |
1166 | } | |
1167 | ||
1168 | static int | |
1169 | ep0_fasync (int f, struct file *fd, int on) | |
1170 | { | |
1171 | struct dev_data *dev = fd->private_data; | |
1172 | // caller must F_SETOWN before signal delivery happens | |
441b62c1 | 1173 | VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off"); |
1da177e4 LT |
1174 | return fasync_helper (f, fd, on, &dev->fasync); |
1175 | } | |
1176 | ||
1177 | static struct usb_gadget_driver gadgetfs_driver; | |
1178 | ||
1179 | static int | |
1180 | dev_release (struct inode *inode, struct file *fd) | |
1181 | { | |
1182 | struct dev_data *dev = fd->private_data; | |
1183 | ||
1184 | /* closing ep0 === shutdown all */ | |
1185 | ||
f50b878f | 1186 | if (dev->gadget_registered) { |
7b0a271d | 1187 | usb_gadget_unregister_driver (&gadgetfs_driver); |
f50b878f AS |
1188 | dev->gadget_registered = false; |
1189 | } | |
1da177e4 LT |
1190 | |
1191 | /* at this point "good" hardware has disconnected the | |
1192 | * device from USB; the host won't see it any more. | |
1193 | * alternatively, all host requests will time out. | |
1194 | */ | |
1195 | ||
1da177e4 LT |
1196 | kfree (dev->buf); |
1197 | dev->buf = NULL; | |
1da177e4 | 1198 | |
f0cae93f MN |
1199 | /* other endpoints were all decoupled from this device */ |
1200 | spin_lock_irq(&dev->lock); | |
1201 | dev->state = STATE_DEV_DISABLED; | |
1202 | spin_unlock_irq(&dev->lock); | |
1203 | ||
1204 | put_dev (dev); | |
1da177e4 LT |
1205 | return 0; |
1206 | } | |
1207 | ||
e22fc27c MS |
1208 | static unsigned int |
1209 | ep0_poll (struct file *fd, poll_table *wait) | |
1210 | { | |
1211 | struct dev_data *dev = fd->private_data; | |
1212 | int mask = 0; | |
1213 | ||
96b62a57 AS |
1214 | if (dev->state <= STATE_DEV_OPENED) |
1215 | return DEFAULT_POLLMASK; | |
1216 | ||
e22fc27c MS |
1217 | poll_wait(fd, &dev->wait, wait); |
1218 | ||
1219 | spin_lock_irq (&dev->lock); | |
1220 | ||
1221 | /* report fd mode change before acting on it */ | |
1222 | if (dev->setup_abort) { | |
1223 | dev->setup_abort = 0; | |
1224 | mask = POLLHUP; | |
1225 | goto out; | |
1226 | } | |
1227 | ||
7489d149 | 1228 | if (dev->state == STATE_DEV_SETUP) { |
e22fc27c MS |
1229 | if (dev->setup_in || dev->setup_can_stall) |
1230 | mask = POLLOUT; | |
1231 | } else { | |
1232 | if (dev->ev_next != 0) | |
1233 | mask = POLLIN; | |
1234 | } | |
1235 | out: | |
1236 | spin_unlock_irq(&dev->lock); | |
1237 | return mask; | |
1238 | } | |
1239 | ||
44c389a0 | 1240 | static long dev_ioctl (struct file *fd, unsigned code, unsigned long value) |
1da177e4 LT |
1241 | { |
1242 | struct dev_data *dev = fd->private_data; | |
1243 | struct usb_gadget *gadget = dev->gadget; | |
44c389a0 | 1244 | long ret = -ENOTTY; |
1da177e4 | 1245 | |
1548b13b | 1246 | if (gadget->ops->ioctl) |
44c389a0 | 1247 | ret = gadget->ops->ioctl (gadget, code, value); |
1548b13b | 1248 | |
44c389a0 | 1249 | return ret; |
1da177e4 LT |
1250 | } |
1251 | ||
1da177e4 LT |
1252 | /*----------------------------------------------------------------------*/ |
1253 | ||
1254 | /* The in-kernel gadget driver handles most ep0 issues, in particular | |
1255 | * enumerating the single configuration (as provided from user space). | |
1256 | * | |
1257 | * Unrecognized ep0 requests may be handled in user space. | |
1258 | */ | |
1259 | ||
1da177e4 LT |
1260 | static void make_qualifier (struct dev_data *dev) |
1261 | { | |
1262 | struct usb_qualifier_descriptor qual; | |
1263 | struct usb_device_descriptor *desc; | |
1264 | ||
1265 | qual.bLength = sizeof qual; | |
1266 | qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER; | |
551509d2 | 1267 | qual.bcdUSB = cpu_to_le16 (0x0200); |
1da177e4 LT |
1268 | |
1269 | desc = dev->dev; | |
1270 | qual.bDeviceClass = desc->bDeviceClass; | |
1271 | qual.bDeviceSubClass = desc->bDeviceSubClass; | |
1272 | qual.bDeviceProtocol = desc->bDeviceProtocol; | |
1273 | ||
1274 | /* assumes ep0 uses the same value for both speeds ... */ | |
765f5b83 | 1275 | qual.bMaxPacketSize0 = dev->gadget->ep0->maxpacket; |
1da177e4 LT |
1276 | |
1277 | qual.bNumConfigurations = 1; | |
1278 | qual.bRESERVED = 0; | |
1279 | ||
1280 | memcpy (dev->rbuf, &qual, sizeof qual); | |
1281 | } | |
1da177e4 LT |
1282 | |
1283 | static int | |
1284 | config_buf (struct dev_data *dev, u8 type, unsigned index) | |
1285 | { | |
1286 | int len; | |
a4e3ef55 | 1287 | int hs = 0; |
1da177e4 LT |
1288 | |
1289 | /* only one configuration */ | |
1290 | if (index > 0) | |
1291 | return -EINVAL; | |
1292 | ||
a4e3ef55 DB |
1293 | if (gadget_is_dualspeed(dev->gadget)) { |
1294 | hs = (dev->gadget->speed == USB_SPEED_HIGH); | |
1295 | if (type == USB_DT_OTHER_SPEED_CONFIG) | |
1296 | hs = !hs; | |
1297 | } | |
1da177e4 LT |
1298 | if (hs) { |
1299 | dev->req->buf = dev->hs_config; | |
01ee7d70 | 1300 | len = le16_to_cpu(dev->hs_config->wTotalLength); |
a4e3ef55 | 1301 | } else { |
1da177e4 | 1302 | dev->req->buf = dev->config; |
01ee7d70 | 1303 | len = le16_to_cpu(dev->config->wTotalLength); |
1da177e4 LT |
1304 | } |
1305 | ((u8 *)dev->req->buf) [1] = type; | |
1306 | return len; | |
1307 | } | |
1308 | ||
1309 | static int | |
1310 | gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl) | |
1311 | { | |
1312 | struct dev_data *dev = get_gadget_data (gadget); | |
1313 | struct usb_request *req = dev->req; | |
1314 | int value = -EOPNOTSUPP; | |
1315 | struct usb_gadgetfs_event *event; | |
1bbc1696 DB |
1316 | u16 w_value = le16_to_cpu(ctrl->wValue); |
1317 | u16 w_length = le16_to_cpu(ctrl->wLength); | |
1da177e4 LT |
1318 | |
1319 | spin_lock (&dev->lock); | |
1320 | dev->setup_abort = 0; | |
7489d149 | 1321 | if (dev->state == STATE_DEV_UNCONNECTED) { |
a4e3ef55 DB |
1322 | if (gadget_is_dualspeed(gadget) |
1323 | && gadget->speed == USB_SPEED_HIGH | |
1324 | && dev->hs_config == NULL) { | |
ce46794f | 1325 | spin_unlock(&dev->lock); |
1da177e4 LT |
1326 | ERROR (dev, "no high speed config??\n"); |
1327 | return -EINVAL; | |
1328 | } | |
1da177e4 | 1329 | |
ce46794f | 1330 | dev->state = STATE_DEV_CONNECTED; |
ce46794f | 1331 | |
1da177e4 LT |
1332 | INFO (dev, "connected\n"); |
1333 | event = next_event (dev, GADGETFS_CONNECT); | |
1334 | event->u.speed = gadget->speed; | |
1335 | ep0_readable (dev); | |
1336 | ||
1da177e4 LT |
1337 | /* host may have given up waiting for response. we can miss control |
1338 | * requests handled lower down (device/endpoint status and features); | |
1339 | * then ep0_{read,write} will report the wrong status. controller | |
1340 | * driver will have aborted pending i/o. | |
1341 | */ | |
7489d149 | 1342 | } else if (dev->state == STATE_DEV_SETUP) |
1da177e4 LT |
1343 | dev->setup_abort = 1; |
1344 | ||
1345 | req->buf = dev->rbuf; | |
1da177e4 LT |
1346 | req->context = NULL; |
1347 | value = -EOPNOTSUPP; | |
1348 | switch (ctrl->bRequest) { | |
1349 | ||
1350 | case USB_REQ_GET_DESCRIPTOR: | |
1351 | if (ctrl->bRequestType != USB_DIR_IN) | |
1352 | goto unrecognized; | |
1353 | switch (w_value >> 8) { | |
1354 | ||
1355 | case USB_DT_DEVICE: | |
1356 | value = min (w_length, (u16) sizeof *dev->dev); | |
765f5b83 | 1357 | dev->dev->bMaxPacketSize0 = dev->gadget->ep0->maxpacket; |
1da177e4 LT |
1358 | req->buf = dev->dev; |
1359 | break; | |
1da177e4 LT |
1360 | case USB_DT_DEVICE_QUALIFIER: |
1361 | if (!dev->hs_config) | |
1362 | break; | |
1363 | value = min (w_length, (u16) | |
1364 | sizeof (struct usb_qualifier_descriptor)); | |
1365 | make_qualifier (dev); | |
1366 | break; | |
1367 | case USB_DT_OTHER_SPEED_CONFIG: | |
1368 | // FALLTHROUGH | |
1da177e4 LT |
1369 | case USB_DT_CONFIG: |
1370 | value = config_buf (dev, | |
1371 | w_value >> 8, | |
1372 | w_value & 0xff); | |
1373 | if (value >= 0) | |
1374 | value = min (w_length, (u16) value); | |
1375 | break; | |
1376 | case USB_DT_STRING: | |
1377 | goto unrecognized; | |
1378 | ||
1379 | default: // all others are errors | |
1380 | break; | |
1381 | } | |
1382 | break; | |
1383 | ||
1384 | /* currently one config, two speeds */ | |
1385 | case USB_REQ_SET_CONFIGURATION: | |
1386 | if (ctrl->bRequestType != 0) | |
12cd5b98 | 1387 | goto unrecognized; |
1da177e4 LT |
1388 | if (0 == (u8) w_value) { |
1389 | value = 0; | |
1390 | dev->current_config = 0; | |
1391 | usb_gadget_vbus_draw(gadget, 8 /* mA */ ); | |
1392 | // user mode expected to disable endpoints | |
1393 | } else { | |
1394 | u8 config, power; | |
a4e3ef55 DB |
1395 | |
1396 | if (gadget_is_dualspeed(gadget) | |
1397 | && gadget->speed == USB_SPEED_HIGH) { | |
1da177e4 LT |
1398 | config = dev->hs_config->bConfigurationValue; |
1399 | power = dev->hs_config->bMaxPower; | |
a4e3ef55 | 1400 | } else { |
1da177e4 LT |
1401 | config = dev->config->bConfigurationValue; |
1402 | power = dev->config->bMaxPower; | |
1403 | } | |
1404 | ||
1405 | if (config == (u8) w_value) { | |
1406 | value = 0; | |
1407 | dev->current_config = config; | |
1408 | usb_gadget_vbus_draw(gadget, 2 * power); | |
1409 | } | |
1410 | } | |
1411 | ||
1412 | /* report SET_CONFIGURATION like any other control request, | |
1413 | * except that usermode may not stall this. the next | |
1414 | * request mustn't be allowed start until this finishes: | |
1415 | * endpoints and threads set up, etc. | |
1416 | * | |
1417 | * NOTE: older PXA hardware (before PXA 255: without UDCCFR) | |
1418 | * has bad/racey automagic that prevents synchronizing here. | |
1419 | * even kernel mode drivers often miss them. | |
1420 | */ | |
1421 | if (value == 0) { | |
1422 | INFO (dev, "configuration #%d\n", dev->current_config); | |
6027f317 | 1423 | usb_gadget_set_state(gadget, USB_STATE_CONFIGURED); |
1da177e4 LT |
1424 | if (dev->usermode_setup) { |
1425 | dev->setup_can_stall = 0; | |
1426 | goto delegate; | |
1427 | } | |
1428 | } | |
1429 | break; | |
1430 | ||
d30f2065 | 1431 | #ifndef CONFIG_USB_PXA25X |
1da177e4 LT |
1432 | /* PXA automagically handles this request too */ |
1433 | case USB_REQ_GET_CONFIGURATION: | |
1434 | if (ctrl->bRequestType != 0x80) | |
12cd5b98 | 1435 | goto unrecognized; |
1da177e4 LT |
1436 | *(u8 *)req->buf = dev->current_config; |
1437 | value = min (w_length, (u16) 1); | |
1438 | break; | |
1439 | #endif | |
1440 | ||
1441 | default: | |
1442 | unrecognized: | |
1443 | VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n", | |
1444 | dev->usermode_setup ? "delegate" : "fail", | |
1445 | ctrl->bRequestType, ctrl->bRequest, | |
1446 | w_value, le16_to_cpu(ctrl->wIndex), w_length); | |
1447 | ||
1448 | /* if there's an ep0 reader, don't stall */ | |
1449 | if (dev->usermode_setup) { | |
1450 | dev->setup_can_stall = 1; | |
1451 | delegate: | |
1452 | dev->setup_in = (ctrl->bRequestType & USB_DIR_IN) | |
1453 | ? 1 : 0; | |
97906369 | 1454 | dev->setup_wLength = w_length; |
1da177e4 LT |
1455 | dev->setup_out_ready = 0; |
1456 | dev->setup_out_error = 0; | |
1457 | value = 0; | |
1458 | ||
1459 | /* read DATA stage for OUT right away */ | |
1460 | if (unlikely (!dev->setup_in && w_length)) { | |
1461 | value = setup_req (gadget->ep0, dev->req, | |
1462 | w_length); | |
1463 | if (value < 0) | |
1464 | break; | |
d246dcb2 BL |
1465 | |
1466 | spin_unlock (&dev->lock); | |
1da177e4 | 1467 | value = usb_ep_queue (gadget->ep0, dev->req, |
d246dcb2 BL |
1468 | GFP_KERNEL); |
1469 | spin_lock (&dev->lock); | |
1da177e4 LT |
1470 | if (value < 0) { |
1471 | clean_req (gadget->ep0, dev->req); | |
1472 | break; | |
1473 | } | |
1474 | ||
1475 | /* we can't currently stall these */ | |
1476 | dev->setup_can_stall = 0; | |
1477 | } | |
1478 | ||
1479 | /* state changes when reader collects event */ | |
1480 | event = next_event (dev, GADGETFS_SETUP); | |
1481 | event->u.setup = *ctrl; | |
1482 | ep0_readable (dev); | |
1483 | spin_unlock (&dev->lock); | |
1484 | return 0; | |
1485 | } | |
1486 | } | |
1487 | ||
1488 | /* proceed with data transfer and status phases? */ | |
7489d149 | 1489 | if (value >= 0 && dev->state != STATE_DEV_SETUP) { |
1da177e4 LT |
1490 | req->length = value; |
1491 | req->zero = value < w_length; | |
d246dcb2 BL |
1492 | |
1493 | spin_unlock (&dev->lock); | |
1494 | value = usb_ep_queue (gadget->ep0, req, GFP_KERNEL); | |
1da177e4 LT |
1495 | if (value < 0) { |
1496 | DBG (dev, "ep_queue --> %d\n", value); | |
1497 | req->status = 0; | |
1498 | } | |
d246dcb2 | 1499 | return value; |
1da177e4 LT |
1500 | } |
1501 | ||
1502 | /* device stalls when value < 0 */ | |
1503 | spin_unlock (&dev->lock); | |
1504 | return value; | |
1505 | } | |
1506 | ||
1507 | static void destroy_ep_files (struct dev_data *dev) | |
1508 | { | |
441b62c1 | 1509 | DBG (dev, "%s %d\n", __func__, dev->state); |
1da177e4 LT |
1510 | |
1511 | /* dev->state must prevent interference */ | |
1da177e4 | 1512 | spin_lock_irq (&dev->lock); |
104bb37d | 1513 | while (!list_empty(&dev->epfiles)) { |
1da177e4 LT |
1514 | struct ep_data *ep; |
1515 | struct inode *parent; | |
1516 | struct dentry *dentry; | |
1517 | ||
1518 | /* break link to FS */ | |
104bb37d | 1519 | ep = list_first_entry (&dev->epfiles, struct ep_data, epfiles); |
1da177e4 LT |
1520 | list_del_init (&ep->epfiles); |
1521 | dentry = ep->dentry; | |
1522 | ep->dentry = NULL; | |
75c3cfa8 | 1523 | parent = d_inode(dentry->d_parent); |
1da177e4 LT |
1524 | |
1525 | /* break link to controller */ | |
1526 | if (ep->state == STATE_EP_ENABLED) | |
1527 | (void) usb_ep_disable (ep->ep); | |
1528 | ep->state = STATE_EP_UNBOUND; | |
1529 | usb_ep_free_request (ep->ep, ep->req); | |
1530 | ep->ep = NULL; | |
1531 | wake_up (&ep->wait); | |
1532 | put_ep (ep); | |
1533 | ||
1534 | spin_unlock_irq (&dev->lock); | |
1535 | ||
1536 | /* break link to dcache */ | |
5955102c | 1537 | inode_lock(parent); |
1da177e4 LT |
1538 | d_delete (dentry); |
1539 | dput (dentry); | |
5955102c | 1540 | inode_unlock(parent); |
1da177e4 | 1541 | |
104bb37d | 1542 | spin_lock_irq (&dev->lock); |
1da177e4 LT |
1543 | } |
1544 | spin_unlock_irq (&dev->lock); | |
1545 | } | |
1546 | ||
1547 | ||
fb6c3225 | 1548 | static struct dentry * |
1da177e4 | 1549 | gadgetfs_create_file (struct super_block *sb, char const *name, |
fb6c3225 | 1550 | void *data, const struct file_operations *fops); |
1da177e4 LT |
1551 | |
1552 | static int activate_ep_files (struct dev_data *dev) | |
1553 | { | |
1554 | struct usb_ep *ep; | |
0ae4ea80 | 1555 | struct ep_data *data; |
1da177e4 LT |
1556 | |
1557 | gadget_for_each_ep (ep, dev->gadget) { | |
1da177e4 | 1558 | |
7039f422 | 1559 | data = kzalloc(sizeof(*data), GFP_KERNEL); |
1da177e4 | 1560 | if (!data) |
0ae4ea80 | 1561 | goto enomem0; |
1da177e4 | 1562 | data->state = STATE_EP_DISABLED; |
a79df50b | 1563 | mutex_init(&data->lock); |
1da177e4 LT |
1564 | init_waitqueue_head (&data->wait); |
1565 | ||
1566 | strncpy (data->name, ep->name, sizeof (data->name) - 1); | |
8d66db50 | 1567 | refcount_set (&data->count, 1); |
1da177e4 LT |
1568 | data->dev = dev; |
1569 | get_dev (dev); | |
1570 | ||
1571 | data->ep = ep; | |
1572 | ep->driver_data = data; | |
1573 | ||
1574 | data->req = usb_ep_alloc_request (ep, GFP_KERNEL); | |
1575 | if (!data->req) | |
0ae4ea80 | 1576 | goto enomem1; |
1da177e4 | 1577 | |
fb6c3225 | 1578 | data->dentry = gadgetfs_create_file (dev->sb, data->name, |
d4461a60 | 1579 | data, &ep_io_operations); |
fb6c3225 | 1580 | if (!data->dentry) |
0ae4ea80 | 1581 | goto enomem2; |
1da177e4 LT |
1582 | list_add_tail (&data->epfiles, &dev->epfiles); |
1583 | } | |
1584 | return 0; | |
1585 | ||
0ae4ea80 AS |
1586 | enomem2: |
1587 | usb_ep_free_request (ep, data->req); | |
1588 | enomem1: | |
1589 | put_dev (dev); | |
1590 | kfree (data); | |
1591 | enomem0: | |
441b62c1 | 1592 | DBG (dev, "%s enomem\n", __func__); |
1da177e4 LT |
1593 | destroy_ep_files (dev); |
1594 | return -ENOMEM; | |
1595 | } | |
1596 | ||
1597 | static void | |
1598 | gadgetfs_unbind (struct usb_gadget *gadget) | |
1599 | { | |
1600 | struct dev_data *dev = get_gadget_data (gadget); | |
1601 | ||
441b62c1 | 1602 | DBG (dev, "%s\n", __func__); |
1da177e4 LT |
1603 | |
1604 | spin_lock_irq (&dev->lock); | |
1605 | dev->state = STATE_DEV_UNBOUND; | |
1606 | spin_unlock_irq (&dev->lock); | |
1607 | ||
1608 | destroy_ep_files (dev); | |
1609 | gadget->ep0->driver_data = NULL; | |
1610 | set_gadget_data (gadget, NULL); | |
1611 | ||
1612 | /* we've already been disconnected ... no i/o is active */ | |
1613 | if (dev->req) | |
1614 | usb_ep_free_request (gadget->ep0, dev->req); | |
441b62c1 | 1615 | DBG (dev, "%s done\n", __func__); |
1da177e4 LT |
1616 | put_dev (dev); |
1617 | } | |
1618 | ||
1619 | static struct dev_data *the_device; | |
1620 | ||
ffe0b335 SAS |
1621 | static int gadgetfs_bind(struct usb_gadget *gadget, |
1622 | struct usb_gadget_driver *driver) | |
1da177e4 LT |
1623 | { |
1624 | struct dev_data *dev = the_device; | |
1625 | ||
1626 | if (!dev) | |
1627 | return -ESRCH; | |
1628 | if (0 != strcmp (CHIP, gadget->name)) { | |
00274921 | 1629 | pr_err("%s expected %s controller not %s\n", |
1da177e4 LT |
1630 | shortname, CHIP, gadget->name); |
1631 | return -ENODEV; | |
1632 | } | |
1633 | ||
1634 | set_gadget_data (gadget, dev); | |
1635 | dev->gadget = gadget; | |
1636 | gadget->ep0->driver_data = dev; | |
1da177e4 LT |
1637 | |
1638 | /* preallocate control response and buffer */ | |
1639 | dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL); | |
1640 | if (!dev->req) | |
1641 | goto enomem; | |
1642 | dev->req->context = NULL; | |
1643 | dev->req->complete = epio_complete; | |
1644 | ||
1645 | if (activate_ep_files (dev) < 0) | |
1646 | goto enomem; | |
1647 | ||
1648 | INFO (dev, "bound to %s driver\n", gadget->name); | |
7489d149 DB |
1649 | spin_lock_irq(&dev->lock); |
1650 | dev->state = STATE_DEV_UNCONNECTED; | |
1651 | spin_unlock_irq(&dev->lock); | |
1da177e4 LT |
1652 | get_dev (dev); |
1653 | return 0; | |
1654 | ||
1655 | enomem: | |
1656 | gadgetfs_unbind (gadget); | |
1657 | return -ENOMEM; | |
1658 | } | |
1659 | ||
1660 | static void | |
1661 | gadgetfs_disconnect (struct usb_gadget *gadget) | |
1662 | { | |
1663 | struct dev_data *dev = get_gadget_data (gadget); | |
001428e4 | 1664 | unsigned long flags; |
1da177e4 | 1665 | |
001428e4 | 1666 | spin_lock_irqsave (&dev->lock, flags); |
7489d149 | 1667 | if (dev->state == STATE_DEV_UNCONNECTED) |
07cb7f23 | 1668 | goto exit; |
7489d149 | 1669 | dev->state = STATE_DEV_UNCONNECTED; |
1da177e4 LT |
1670 | |
1671 | INFO (dev, "disconnected\n"); | |
1da177e4 LT |
1672 | next_event (dev, GADGETFS_DISCONNECT); |
1673 | ep0_readable (dev); | |
07cb7f23 | 1674 | exit: |
001428e4 | 1675 | spin_unlock_irqrestore (&dev->lock, flags); |
1da177e4 LT |
1676 | } |
1677 | ||
1678 | static void | |
1679 | gadgetfs_suspend (struct usb_gadget *gadget) | |
1680 | { | |
1681 | struct dev_data *dev = get_gadget_data (gadget); | |
f16443a0 | 1682 | unsigned long flags; |
1da177e4 LT |
1683 | |
1684 | INFO (dev, "suspended from state %d\n", dev->state); | |
f16443a0 | 1685 | spin_lock_irqsave(&dev->lock, flags); |
1da177e4 | 1686 | switch (dev->state) { |
7489d149 DB |
1687 | case STATE_DEV_SETUP: // VERY odd... host died?? |
1688 | case STATE_DEV_CONNECTED: | |
1689 | case STATE_DEV_UNCONNECTED: | |
1da177e4 LT |
1690 | next_event (dev, GADGETFS_SUSPEND); |
1691 | ep0_readable (dev); | |
1692 | /* FALLTHROUGH */ | |
1693 | default: | |
1694 | break; | |
1695 | } | |
f16443a0 | 1696 | spin_unlock_irqrestore(&dev->lock, flags); |
1da177e4 LT |
1697 | } |
1698 | ||
1699 | static struct usb_gadget_driver gadgetfs_driver = { | |
1da177e4 | 1700 | .function = (char *) driver_desc, |
93952956 | 1701 | .bind = gadgetfs_bind, |
1da177e4 LT |
1702 | .unbind = gadgetfs_unbind, |
1703 | .setup = gadgetfs_setup, | |
0eba4550 | 1704 | .reset = gadgetfs_disconnect, |
1da177e4 LT |
1705 | .disconnect = gadgetfs_disconnect, |
1706 | .suspend = gadgetfs_suspend, | |
1707 | ||
2505107d | 1708 | .driver = { |
1da177e4 | 1709 | .name = (char *) shortname, |
1da177e4 LT |
1710 | }, |
1711 | }; | |
1712 | ||
1713 | /*----------------------------------------------------------------------*/ | |
1da177e4 LT |
1714 | /* DEVICE INITIALIZATION |
1715 | * | |
1716 | * fd = open ("/dev/gadget/$CHIP", O_RDWR) | |
1717 | * status = write (fd, descriptors, sizeof descriptors) | |
1718 | * | |
1719 | * That write establishes the device configuration, so the kernel can | |
1720 | * bind to the controller ... guaranteeing it can handle enumeration | |
1721 | * at all necessary speeds. Descriptor order is: | |
1722 | * | |
1723 | * . message tag (u32, host order) ... for now, must be zero; it | |
1724 | * would change to support features like multi-config devices | |
1725 | * . full/low speed config ... all wTotalLength bytes (with interface, | |
1726 | * class, altsetting, endpoint, and other descriptors) | |
1727 | * . high speed config ... all descriptors, for high speed operation; | |
2505107d | 1728 | * this one's optional except for high-speed hardware |
1da177e4 LT |
1729 | * . device descriptor |
1730 | * | |
511779fd PE |
1731 | * Endpoints are not yet enabled. Drivers must wait until device |
1732 | * configuration and interface altsetting changes create | |
1da177e4 LT |
1733 | * the need to configure (or unconfigure) them. |
1734 | * | |
1735 | * After initialization, the device stays active for as long as that | |
511779fd PE |
1736 | * $CHIP file is open. Events must then be read from that descriptor, |
1737 | * such as configuration notifications. | |
1da177e4 LT |
1738 | */ |
1739 | ||
1c069b05 AS |
1740 | static int is_valid_config(struct usb_config_descriptor *config, |
1741 | unsigned int total) | |
1da177e4 LT |
1742 | { |
1743 | return config->bDescriptorType == USB_DT_CONFIG | |
1744 | && config->bLength == USB_DT_CONFIG_SIZE | |
1c069b05 | 1745 | && total >= USB_DT_CONFIG_SIZE |
1da177e4 LT |
1746 | && config->bConfigurationValue != 0 |
1747 | && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0 | |
1748 | && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0; | |
1749 | /* FIXME if gadget->is_otg, _must_ include an otg descriptor */ | |
1750 | /* FIXME check lengths: walk to end */ | |
1751 | } | |
1752 | ||
1753 | static ssize_t | |
1754 | dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr) | |
1755 | { | |
1756 | struct dev_data *dev = fd->private_data; | |
1757 | ssize_t value = len, length = len; | |
1758 | unsigned total; | |
1759 | u32 tag; | |
1760 | char *kbuf; | |
1761 | ||
96b62a57 AS |
1762 | spin_lock_irq(&dev->lock); |
1763 | if (dev->state > STATE_DEV_OPENED) { | |
1764 | value = ep0_write(fd, buf, len, ptr); | |
1765 | spin_unlock_irq(&dev->lock); | |
1766 | return value; | |
1767 | } | |
1768 | spin_unlock_irq(&dev->lock); | |
1769 | ||
0994b0a2 GKH |
1770 | if ((len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4)) || |
1771 | (len > PAGE_SIZE * 4)) | |
1da177e4 LT |
1772 | return -EINVAL; |
1773 | ||
1774 | /* we might need to change message format someday */ | |
1775 | if (copy_from_user (&tag, buf, 4)) | |
1776 | return -EFAULT; | |
1777 | if (tag != 0) | |
1778 | return -EINVAL; | |
1779 | buf += 4; | |
1780 | length -= 4; | |
1781 | ||
be8a058b JL |
1782 | kbuf = memdup_user(buf, length); |
1783 | if (IS_ERR(kbuf)) | |
1784 | return PTR_ERR(kbuf); | |
1da177e4 LT |
1785 | |
1786 | spin_lock_irq (&dev->lock); | |
1787 | value = -EINVAL; | |
b6e7aeea CJ |
1788 | if (dev->buf) { |
1789 | kfree(kbuf); | |
1da177e4 | 1790 | goto fail; |
b6e7aeea | 1791 | } |
1da177e4 LT |
1792 | dev->buf = kbuf; |
1793 | ||
1794 | /* full or low speed config */ | |
1795 | dev->config = (void *) kbuf; | |
01ee7d70 | 1796 | total = le16_to_cpu(dev->config->wTotalLength); |
1c069b05 AS |
1797 | if (!is_valid_config(dev->config, total) || |
1798 | total > length - USB_DT_DEVICE_SIZE) | |
1da177e4 LT |
1799 | goto fail; |
1800 | kbuf += total; | |
1801 | length -= total; | |
1802 | ||
1803 | /* optional high speed config */ | |
1804 | if (kbuf [1] == USB_DT_CONFIG) { | |
1805 | dev->hs_config = (void *) kbuf; | |
01ee7d70 | 1806 | total = le16_to_cpu(dev->hs_config->wTotalLength); |
1c069b05 AS |
1807 | if (!is_valid_config(dev->hs_config, total) || |
1808 | total > length - USB_DT_DEVICE_SIZE) | |
1da177e4 LT |
1809 | goto fail; |
1810 | kbuf += total; | |
1811 | length -= total; | |
add333a8 AS |
1812 | } else { |
1813 | dev->hs_config = NULL; | |
1da177e4 LT |
1814 | } |
1815 | ||
1816 | /* could support multiple configs, using another encoding! */ | |
1817 | ||
1818 | /* device descriptor (tweaked for paranoia) */ | |
1819 | if (length != USB_DT_DEVICE_SIZE) | |
1820 | goto fail; | |
1821 | dev->dev = (void *)kbuf; | |
1822 | if (dev->dev->bLength != USB_DT_DEVICE_SIZE | |
1823 | || dev->dev->bDescriptorType != USB_DT_DEVICE | |
1824 | || dev->dev->bNumConfigurations != 1) | |
1825 | goto fail; | |
551509d2 | 1826 | dev->dev->bcdUSB = cpu_to_le16 (0x0200); |
1da177e4 LT |
1827 | |
1828 | /* triggers gadgetfs_bind(); then we can enumerate. */ | |
1829 | spin_unlock_irq (&dev->lock); | |
85b8614d MN |
1830 | if (dev->hs_config) |
1831 | gadgetfs_driver.max_speed = USB_SPEED_HIGH; | |
1832 | else | |
1833 | gadgetfs_driver.max_speed = USB_SPEED_FULL; | |
93952956 SAS |
1834 | |
1835 | value = usb_gadget_probe_driver(&gadgetfs_driver); | |
1da177e4 LT |
1836 | if (value != 0) { |
1837 | kfree (dev->buf); | |
1838 | dev->buf = NULL; | |
1839 | } else { | |
1840 | /* at this point "good" hardware has for the first time | |
1841 | * let the USB the host see us. alternatively, if users | |
1842 | * unplug/replug that will clear all the error state. | |
1843 | * | |
1844 | * note: everything running before here was guaranteed | |
1845 | * to choke driver model style diagnostics. from here | |
1846 | * on, they can work ... except in cleanup paths that | |
1847 | * kick in after the ep0 descriptor is closed. | |
1848 | */ | |
1da177e4 | 1849 | value = len; |
7b0a271d | 1850 | dev->gadget_registered = true; |
1da177e4 LT |
1851 | } |
1852 | return value; | |
1853 | ||
1854 | fail: | |
1855 | spin_unlock_irq (&dev->lock); | |
5b5e0928 | 1856 | pr_debug ("%s: %s fail %zd, %p\n", shortname, __func__, value, dev); |
1da177e4 LT |
1857 | kfree (dev->buf); |
1858 | dev->buf = NULL; | |
1859 | return value; | |
1860 | } | |
1861 | ||
1862 | static int | |
1863 | dev_open (struct inode *inode, struct file *fd) | |
1864 | { | |
8e18e294 | 1865 | struct dev_data *dev = inode->i_private; |
1da177e4 LT |
1866 | int value = -EBUSY; |
1867 | ||
7489d149 | 1868 | spin_lock_irq(&dev->lock); |
1da177e4 LT |
1869 | if (dev->state == STATE_DEV_DISABLED) { |
1870 | dev->ev_next = 0; | |
7489d149 | 1871 | dev->state = STATE_DEV_OPENED; |
1da177e4 LT |
1872 | fd->private_data = dev; |
1873 | get_dev (dev); | |
1874 | value = 0; | |
1875 | } | |
7489d149 | 1876 | spin_unlock_irq(&dev->lock); |
1da177e4 LT |
1877 | return value; |
1878 | } | |
1879 | ||
96b62a57 | 1880 | static const struct file_operations ep0_operations = { |
1da177e4 LT |
1881 | .llseek = no_llseek, |
1882 | ||
1883 | .open = dev_open, | |
96b62a57 | 1884 | .read = ep0_read, |
1da177e4 LT |
1885 | .write = dev_config, |
1886 | .fasync = ep0_fasync, | |
96b62a57 | 1887 | .poll = ep0_poll, |
44c389a0 | 1888 | .unlocked_ioctl = dev_ioctl, |
1da177e4 LT |
1889 | .release = dev_release, |
1890 | }; | |
1891 | ||
1892 | /*----------------------------------------------------------------------*/ | |
1893 | ||
1894 | /* FILESYSTEM AND SUPERBLOCK OPERATIONS | |
1895 | * | |
1896 | * Mounting the filesystem creates a controller file, used first for | |
1897 | * device configuration then later for event monitoring. | |
1898 | */ | |
1899 | ||
1900 | ||
1901 | /* FIXME PAM etc could set this security policy without mount options | |
1902 | * if epfiles inherited ownership and permissons from ep0 ... | |
1903 | */ | |
1904 | ||
1905 | static unsigned default_uid; | |
1906 | static unsigned default_gid; | |
1907 | static unsigned default_perm = S_IRUSR | S_IWUSR; | |
1908 | ||
1909 | module_param (default_uid, uint, 0644); | |
1910 | module_param (default_gid, uint, 0644); | |
1911 | module_param (default_perm, uint, 0644); | |
1912 | ||
1913 | ||
1914 | static struct inode * | |
1915 | gadgetfs_make_inode (struct super_block *sb, | |
99ac48f5 | 1916 | void *data, const struct file_operations *fops, |
1da177e4 LT |
1917 | int mode) |
1918 | { | |
1919 | struct inode *inode = new_inode (sb); | |
1920 | ||
1921 | if (inode) { | |
85fe4025 | 1922 | inode->i_ino = get_next_ino(); |
1da177e4 | 1923 | inode->i_mode = mode; |
32d639c6 EB |
1924 | inode->i_uid = make_kuid(&init_user_ns, default_uid); |
1925 | inode->i_gid = make_kgid(&init_user_ns, default_gid); | |
1da177e4 | 1926 | inode->i_atime = inode->i_mtime = inode->i_ctime |
078cd827 | 1927 | = current_time(inode); |
8e18e294 | 1928 | inode->i_private = data; |
1da177e4 LT |
1929 | inode->i_fop = fops; |
1930 | } | |
1931 | return inode; | |
1932 | } | |
1933 | ||
1934 | /* creates in fs root directory, so non-renamable and non-linkable. | |
1935 | * so inode and dentry are paired, until device reconfig. | |
1936 | */ | |
fb6c3225 | 1937 | static struct dentry * |
1da177e4 | 1938 | gadgetfs_create_file (struct super_block *sb, char const *name, |
fb6c3225 | 1939 | void *data, const struct file_operations *fops) |
1da177e4 LT |
1940 | { |
1941 | struct dentry *dentry; | |
1942 | struct inode *inode; | |
1943 | ||
1944 | dentry = d_alloc_name(sb->s_root, name); | |
1945 | if (!dentry) | |
1946 | return NULL; | |
1947 | ||
1948 | inode = gadgetfs_make_inode (sb, data, fops, | |
1949 | S_IFREG | (default_perm & S_IRWXUGO)); | |
1950 | if (!inode) { | |
1951 | dput(dentry); | |
1952 | return NULL; | |
1953 | } | |
1954 | d_add (dentry, inode); | |
fb6c3225 | 1955 | return dentry; |
1da177e4 LT |
1956 | } |
1957 | ||
b87221de | 1958 | static const struct super_operations gadget_fs_operations = { |
1da177e4 LT |
1959 | .statfs = simple_statfs, |
1960 | .drop_inode = generic_delete_inode, | |
1961 | }; | |
1962 | ||
1963 | static int | |
1964 | gadgetfs_fill_super (struct super_block *sb, void *opts, int silent) | |
1965 | { | |
1966 | struct inode *inode; | |
1da177e4 LT |
1967 | struct dev_data *dev; |
1968 | ||
1969 | if (the_device) | |
1970 | return -ESRCH; | |
1971 | ||
175f7121 | 1972 | CHIP = usb_get_gadget_udc_name(); |
1da177e4 LT |
1973 | if (!CHIP) |
1974 | return -ENODEV; | |
1975 | ||
1976 | /* superblock */ | |
09cbfeaf KS |
1977 | sb->s_blocksize = PAGE_SIZE; |
1978 | sb->s_blocksize_bits = PAGE_SHIFT; | |
1da177e4 LT |
1979 | sb->s_magic = GADGETFS_MAGIC; |
1980 | sb->s_op = &gadget_fs_operations; | |
1981 | sb->s_time_gran = 1; | |
1982 | ||
1983 | /* root inode */ | |
1984 | inode = gadgetfs_make_inode (sb, | |
1985 | NULL, &simple_dir_operations, | |
1986 | S_IFDIR | S_IRUGO | S_IXUGO); | |
1987 | if (!inode) | |
87da5b32 | 1988 | goto Enomem; |
1da177e4 | 1989 | inode->i_op = &simple_dir_inode_operations; |
48fde701 | 1990 | if (!(sb->s_root = d_make_root (inode))) |
87da5b32 | 1991 | goto Enomem; |
1da177e4 LT |
1992 | |
1993 | /* the ep0 file is named after the controller we expect; | |
1994 | * user mode code can use it for sanity checks, like we do. | |
1995 | */ | |
1996 | dev = dev_new (); | |
1997 | if (!dev) | |
87da5b32 | 1998 | goto Enomem; |
1da177e4 LT |
1999 | |
2000 | dev->sb = sb; | |
96b62a57 | 2001 | dev->dentry = gadgetfs_create_file(sb, CHIP, dev, &ep0_operations); |
fb6c3225 | 2002 | if (!dev->dentry) { |
87da5b32 AV |
2003 | put_dev(dev); |
2004 | goto Enomem; | |
2005 | } | |
1da177e4 LT |
2006 | |
2007 | /* other endpoint files are available after hardware setup, | |
2008 | * from binding to a controller. | |
2009 | */ | |
2010 | the_device = dev; | |
2011 | return 0; | |
0ae4ea80 | 2012 | |
87da5b32 | 2013 | Enomem: |
0ae4ea80 | 2014 | return -ENOMEM; |
1da177e4 LT |
2015 | } |
2016 | ||
2017 | /* "mount -t gadgetfs path /dev/gadget" ends up here */ | |
fc14f2fe AV |
2018 | static struct dentry * |
2019 | gadgetfs_mount (struct file_system_type *t, int flags, | |
2020 | const char *path, void *opts) | |
1da177e4 | 2021 | { |
fc14f2fe | 2022 | return mount_single (t, flags, opts, gadgetfs_fill_super); |
1da177e4 LT |
2023 | } |
2024 | ||
2025 | static void | |
2026 | gadgetfs_kill_sb (struct super_block *sb) | |
2027 | { | |
2028 | kill_litter_super (sb); | |
2029 | if (the_device) { | |
2030 | put_dev (the_device); | |
2031 | the_device = NULL; | |
2032 | } | |
175f7121 MS |
2033 | kfree(CHIP); |
2034 | CHIP = NULL; | |
1da177e4 LT |
2035 | } |
2036 | ||
2037 | /*----------------------------------------------------------------------*/ | |
2038 | ||
2039 | static struct file_system_type gadgetfs_type = { | |
2040 | .owner = THIS_MODULE, | |
2041 | .name = shortname, | |
fc14f2fe | 2042 | .mount = gadgetfs_mount, |
1da177e4 LT |
2043 | .kill_sb = gadgetfs_kill_sb, |
2044 | }; | |
7f78e035 | 2045 | MODULE_ALIAS_FS("gadgetfs"); |
1da177e4 LT |
2046 | |
2047 | /*----------------------------------------------------------------------*/ | |
2048 | ||
2049 | static int __init init (void) | |
2050 | { | |
2051 | int status; | |
2052 | ||
2053 | status = register_filesystem (&gadgetfs_type); | |
2054 | if (status == 0) | |
2055 | pr_info ("%s: %s, version " DRIVER_VERSION "\n", | |
2056 | shortname, driver_desc); | |
2057 | return status; | |
2058 | } | |
2059 | module_init (init); | |
2060 | ||
2061 | static void __exit cleanup (void) | |
2062 | { | |
2063 | pr_debug ("unregister %s\n", shortname); | |
2064 | unregister_filesystem (&gadgetfs_type); | |
2065 | } | |
2066 | module_exit (cleanup); | |
2067 |