USB: pxa27x_udc: add otg transceiver support
[linux-2.6-block.git] / drivers / usb / gadget / pxa27x_udc.c
CommitLineData
d75379a5
RJ
1/*
2 * Handles the Intel 27x USB Device Controller (UDC)
3 *
4 * Inspired by original driver by Frank Becker, David Brownell, and others.
5 * Copyright (C) 2008 Robert Jarzmik
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.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 */
22#include <linux/module.h>
23#include <linux/kernel.h>
24#include <linux/types.h>
d75379a5
RJ
25#include <linux/errno.h>
26#include <linux/platform_device.h>
27#include <linux/delay.h>
28#include <linux/list.h>
29#include <linux/interrupt.h>
30#include <linux/proc_fs.h>
31#include <linux/clk.h>
32#include <linux/irq.h>
eb507025 33#include <linux/gpio.h>
d75379a5
RJ
34
35#include <asm/byteorder.h>
a09e64fb 36#include <mach/hardware.h>
d75379a5
RJ
37
38#include <linux/usb.h>
39#include <linux/usb/ch9.h>
40#include <linux/usb/gadget.h>
a09e64fb
RK
41#include <mach/pxa2xx-regs.h> /* FIXME: for PSSR */
42#include <mach/udc.h>
d75379a5
RJ
43
44#include "pxa27x_udc.h"
45
46/*
47 * This driver handles the USB Device Controller (UDC) in Intel's PXA 27x
48 * series processors.
49 *
50 * Such controller drivers work with a gadget driver. The gadget driver
51 * returns descriptors, implements configuration and data protocols used
52 * by the host to interact with this device, and allocates endpoints to
53 * the different protocol interfaces. The controller driver virtualizes
54 * usb hardware so that the gadget drivers will be more portable.
55 *
56 * This UDC hardware wants to implement a bit too much USB protocol. The
57 * biggest issues are: that the endpoints have to be set up before the
58 * controller can be enabled (minor, and not uncommon); and each endpoint
59 * can only have one configuration, interface and alternative interface
60 * number (major, and very unusual). Once set up, these cannot be changed
61 * without a controller reset.
62 *
63 * The workaround is to setup all combinations necessary for the gadgets which
64 * will work with this driver. This is done in pxa_udc structure, statically.
65 * See pxa_udc, udc_usb_ep versus pxa_ep, and matching function find_pxa_ep.
66 * (You could modify this if needed. Some drivers have a "fifo_mode" module
67 * parameter to facilitate such changes.)
68 *
69 * The combinations have been tested with these gadgets :
70 * - zero gadget
71 * - file storage gadget
72 * - ether gadget
73 *
74 * The driver doesn't use DMA, only IO access and IRQ callbacks. No use is
75 * made of UDC's double buffering either. USB "On-The-Go" is not implemented.
76 *
77 * All the requests are handled the same way :
78 * - the drivers tries to handle the request directly to the IO
79 * - if the IO fifo is not big enough, the remaining is send/received in
80 * interrupt handling.
81 */
82
83#define DRIVER_VERSION "2008-04-18"
84#define DRIVER_DESC "PXA 27x USB Device Controller driver"
85
86static const char driver_name[] = "pxa27x_udc";
87static struct pxa_udc *the_controller;
88
89static void handle_ep(struct pxa_ep *ep);
90
91/*
92 * Debug filesystem
93 */
94#ifdef CONFIG_USB_GADGET_DEBUG_FS
95
96#include <linux/debugfs.h>
97#include <linux/uaccess.h>
98#include <linux/seq_file.h>
99
100static int state_dbg_show(struct seq_file *s, void *p)
101{
102 struct pxa_udc *udc = s->private;
103 int pos = 0, ret;
104 u32 tmp;
105
106 ret = -ENODEV;
107 if (!udc->driver)
108 goto out;
109
110 /* basic device status */
111 pos += seq_printf(s, DRIVER_DESC "\n"
112 "%s version: %s\nGadget driver: %s\n",
113 driver_name, DRIVER_VERSION,
114 udc->driver ? udc->driver->driver.name : "(none)");
115
116 tmp = udc_readl(udc, UDCCR);
117 pos += seq_printf(s,
118 "udccr=0x%0x(%s%s%s%s%s%s%s%s%s%s), "
119 "con=%d,inter=%d,altinter=%d\n", tmp,
120 (tmp & UDCCR_OEN) ? " oen":"",
121 (tmp & UDCCR_AALTHNP) ? " aalthnp":"",
122 (tmp & UDCCR_AHNP) ? " rem" : "",
123 (tmp & UDCCR_BHNP) ? " rstir" : "",
124 (tmp & UDCCR_DWRE) ? " dwre" : "",
125 (tmp & UDCCR_SMAC) ? " smac" : "",
126 (tmp & UDCCR_EMCE) ? " emce" : "",
127 (tmp & UDCCR_UDR) ? " udr" : "",
128 (tmp & UDCCR_UDA) ? " uda" : "",
129 (tmp & UDCCR_UDE) ? " ude" : "",
130 (tmp & UDCCR_ACN) >> UDCCR_ACN_S,
131 (tmp & UDCCR_AIN) >> UDCCR_AIN_S,
132 (tmp & UDCCR_AAISN) >> UDCCR_AAISN_S);
133 /* registers for device and ep0 */
134 pos += seq_printf(s, "udcicr0=0x%08x udcicr1=0x%08x\n",
135 udc_readl(udc, UDCICR0), udc_readl(udc, UDCICR1));
136 pos += seq_printf(s, "udcisr0=0x%08x udcisr1=0x%08x\n",
137 udc_readl(udc, UDCISR0), udc_readl(udc, UDCISR1));
138 pos += seq_printf(s, "udcfnr=%d\n", udc_readl(udc, UDCFNR));
139 pos += seq_printf(s, "irqs: reset=%lu, suspend=%lu, resume=%lu, "
140 "reconfig=%lu\n",
141 udc->stats.irqs_reset, udc->stats.irqs_suspend,
142 udc->stats.irqs_resume, udc->stats.irqs_reconfig);
143
144 ret = 0;
145out:
146 return ret;
147}
148
149static int queues_dbg_show(struct seq_file *s, void *p)
150{
151 struct pxa_udc *udc = s->private;
152 struct pxa_ep *ep;
153 struct pxa27x_request *req;
154 int pos = 0, i, maxpkt, ret;
155
156 ret = -ENODEV;
157 if (!udc->driver)
158 goto out;
159
160 /* dump endpoint queues */
161 for (i = 0; i < NR_PXA_ENDPOINTS; i++) {
162 ep = &udc->pxa_ep[i];
163 maxpkt = ep->fifo_size;
164 pos += seq_printf(s, "%-12s max_pkt=%d %s\n",
165 EPNAME(ep), maxpkt, "pio");
166
167 if (list_empty(&ep->queue)) {
168 pos += seq_printf(s, "\t(nothing queued)\n");
169 continue;
170 }
171
172 list_for_each_entry(req, &ep->queue, queue) {
173 pos += seq_printf(s, "\treq %p len %d/%d buf %p\n",
174 &req->req, req->req.actual,
175 req->req.length, req->req.buf);
176 }
177 }
178
179 ret = 0;
180out:
181 return ret;
182}
183
184static int eps_dbg_show(struct seq_file *s, void *p)
185{
186 struct pxa_udc *udc = s->private;
187 struct pxa_ep *ep;
188 int pos = 0, i, ret;
189 u32 tmp;
190
191 ret = -ENODEV;
192 if (!udc->driver)
193 goto out;
194
195 ep = &udc->pxa_ep[0];
196 tmp = udc_ep_readl(ep, UDCCSR);
197 pos += seq_printf(s, "udccsr0=0x%03x(%s%s%s%s%s%s%s)\n", tmp,
198 (tmp & UDCCSR0_SA) ? " sa" : "",
199 (tmp & UDCCSR0_RNE) ? " rne" : "",
200 (tmp & UDCCSR0_FST) ? " fst" : "",
201 (tmp & UDCCSR0_SST) ? " sst" : "",
202 (tmp & UDCCSR0_DME) ? " dme" : "",
203 (tmp & UDCCSR0_IPR) ? " ipr" : "",
204 (tmp & UDCCSR0_OPC) ? " opc" : "");
205 for (i = 0; i < NR_PXA_ENDPOINTS; i++) {
206 ep = &udc->pxa_ep[i];
207 tmp = i? udc_ep_readl(ep, UDCCR) : udc_readl(udc, UDCCR);
208 pos += seq_printf(s, "%-12s: "
209 "IN %lu(%lu reqs), OUT %lu(%lu reqs), "
210 "irqs=%lu, udccr=0x%08x, udccsr=0x%03x, "
211 "udcbcr=%d\n",
212 EPNAME(ep),
213 ep->stats.in_bytes, ep->stats.in_ops,
214 ep->stats.out_bytes, ep->stats.out_ops,
215 ep->stats.irqs,
216 tmp, udc_ep_readl(ep, UDCCSR),
217 udc_ep_readl(ep, UDCBCR));
218 }
219
220 ret = 0;
221out:
222 return ret;
223}
224
225static int eps_dbg_open(struct inode *inode, struct file *file)
226{
227 return single_open(file, eps_dbg_show, inode->i_private);
228}
229
230static int queues_dbg_open(struct inode *inode, struct file *file)
231{
232 return single_open(file, queues_dbg_show, inode->i_private);
233}
234
235static int state_dbg_open(struct inode *inode, struct file *file)
236{
237 return single_open(file, state_dbg_show, inode->i_private);
238}
239
240static const struct file_operations state_dbg_fops = {
241 .owner = THIS_MODULE,
242 .open = state_dbg_open,
243 .llseek = seq_lseek,
244 .read = seq_read,
245 .release = single_release,
246};
247
248static const struct file_operations queues_dbg_fops = {
249 .owner = THIS_MODULE,
250 .open = queues_dbg_open,
251 .llseek = seq_lseek,
252 .read = seq_read,
253 .release = single_release,
254};
255
256static const struct file_operations eps_dbg_fops = {
257 .owner = THIS_MODULE,
258 .open = eps_dbg_open,
259 .llseek = seq_lseek,
260 .read = seq_read,
261 .release = single_release,
262};
263
264static void pxa_init_debugfs(struct pxa_udc *udc)
265{
266 struct dentry *root, *state, *queues, *eps;
267
268 root = debugfs_create_dir(udc->gadget.name, NULL);
269 if (IS_ERR(root) || !root)
270 goto err_root;
271
272 state = debugfs_create_file("udcstate", 0400, root, udc,
273 &state_dbg_fops);
274 if (!state)
275 goto err_state;
276 queues = debugfs_create_file("queues", 0400, root, udc,
277 &queues_dbg_fops);
278 if (!queues)
279 goto err_queues;
280 eps = debugfs_create_file("epstate", 0400, root, udc,
281 &eps_dbg_fops);
282 if (!queues)
283 goto err_eps;
284
285 udc->debugfs_root = root;
286 udc->debugfs_state = state;
287 udc->debugfs_queues = queues;
288 udc->debugfs_eps = eps;
289 return;
290err_eps:
291 debugfs_remove(eps);
292err_queues:
293 debugfs_remove(queues);
294err_state:
295 debugfs_remove(root);
296err_root:
297 dev_err(udc->dev, "debugfs is not available\n");
298}
299
300static void pxa_cleanup_debugfs(struct pxa_udc *udc)
301{
302 debugfs_remove(udc->debugfs_eps);
303 debugfs_remove(udc->debugfs_queues);
304 debugfs_remove(udc->debugfs_state);
305 debugfs_remove(udc->debugfs_root);
306 udc->debugfs_eps = NULL;
307 udc->debugfs_queues = NULL;
308 udc->debugfs_state = NULL;
309 udc->debugfs_root = NULL;
310}
311
312#else
313static inline void pxa_init_debugfs(struct pxa_udc *udc)
314{
315}
316
317static inline void pxa_cleanup_debugfs(struct pxa_udc *udc)
318{
319}
320#endif
321
322/**
323 * is_match_usb_pxa - check if usb_ep and pxa_ep match
324 * @udc_usb_ep: usb endpoint
325 * @ep: pxa endpoint
326 * @config: configuration required in pxa_ep
327 * @interface: interface required in pxa_ep
328 * @altsetting: altsetting required in pxa_ep
329 *
330 * Returns 1 if all criteria match between pxa and usb endpoint, 0 otherwise
331 */
332static int is_match_usb_pxa(struct udc_usb_ep *udc_usb_ep, struct pxa_ep *ep,
333 int config, int interface, int altsetting)
334{
335 if (usb_endpoint_num(&udc_usb_ep->desc) != ep->addr)
336 return 0;
337 if (usb_endpoint_dir_in(&udc_usb_ep->desc) != ep->dir_in)
338 return 0;
339 if (usb_endpoint_type(&udc_usb_ep->desc) != ep->type)
340 return 0;
341 if ((ep->config != config) || (ep->interface != interface)
342 || (ep->alternate != altsetting))
343 return 0;
344 return 1;
345}
346
347/**
348 * find_pxa_ep - find pxa_ep structure matching udc_usb_ep
349 * @udc: pxa udc
350 * @udc_usb_ep: udc_usb_ep structure
351 *
352 * Match udc_usb_ep and all pxa_ep available, to see if one matches.
353 * This is necessary because of the strong pxa hardware restriction requiring
354 * that once pxa endpoints are initialized, their configuration is freezed, and
355 * no change can be made to their address, direction, or in which configuration,
356 * interface or altsetting they are active ... which differs from more usual
357 * models which have endpoints be roughly just addressable fifos, and leave
358 * configuration events up to gadget drivers (like all control messages).
359 *
360 * Note that there is still a blurred point here :
361 * - we rely on UDCCR register "active interface" and "active altsetting".
362 * This is a nonsense in regard of USB spec, where multiple interfaces are
363 * active at the same time.
364 * - if we knew for sure that the pxa can handle multiple interface at the
365 * same time, assuming Intel's Developer Guide is wrong, this function
366 * should be reviewed, and a cache of couples (iface, altsetting) should
367 * be kept in the pxa_udc structure. In this case this function would match
368 * against the cache of couples instead of the "last altsetting" set up.
369 *
370 * Returns the matched pxa_ep structure or NULL if none found
371 */
372static struct pxa_ep *find_pxa_ep(struct pxa_udc *udc,
373 struct udc_usb_ep *udc_usb_ep)
374{
375 int i;
376 struct pxa_ep *ep;
377 int cfg = udc->config;
378 int iface = udc->last_interface;
379 int alt = udc->last_alternate;
380
381 if (udc_usb_ep == &udc->udc_usb_ep[0])
382 return &udc->pxa_ep[0];
383
384 for (i = 1; i < NR_PXA_ENDPOINTS; i++) {
385 ep = &udc->pxa_ep[i];
386 if (is_match_usb_pxa(udc_usb_ep, ep, cfg, iface, alt))
387 return ep;
388 }
389 return NULL;
390}
391
392/**
393 * update_pxa_ep_matches - update pxa_ep cached values in all udc_usb_ep
394 * @udc: pxa udc
395 *
396 * Context: in_interrupt()
397 *
398 * Updates all pxa_ep fields in udc_usb_ep structures, if this field was
399 * previously set up (and is not NULL). The update is necessary is a
400 * configuration change or altsetting change was issued by the USB host.
401 */
402static void update_pxa_ep_matches(struct pxa_udc *udc)
403{
404 int i;
405 struct udc_usb_ep *udc_usb_ep;
406
407 for (i = 1; i < NR_USB_ENDPOINTS; i++) {
408 udc_usb_ep = &udc->udc_usb_ep[i];
409 if (udc_usb_ep->pxa_ep)
410 udc_usb_ep->pxa_ep = find_pxa_ep(udc, udc_usb_ep);
411 }
412}
413
414/**
415 * pio_irq_enable - Enables irq generation for one endpoint
416 * @ep: udc endpoint
417 */
418static void pio_irq_enable(struct pxa_ep *ep)
419{
420 struct pxa_udc *udc = ep->dev;
421 int index = EPIDX(ep);
422 u32 udcicr0 = udc_readl(udc, UDCICR0);
423 u32 udcicr1 = udc_readl(udc, UDCICR1);
424
425 if (index < 16)
426 udc_writel(udc, UDCICR0, udcicr0 | (3 << (index * 2)));
427 else
428 udc_writel(udc, UDCICR1, udcicr1 | (3 << ((index - 16) * 2)));
429}
430
431/**
432 * pio_irq_disable - Disables irq generation for one endpoint
433 * @ep: udc endpoint
d75379a5
RJ
434 */
435static void pio_irq_disable(struct pxa_ep *ep)
436{
437 struct pxa_udc *udc = ep->dev;
438 int index = EPIDX(ep);
439 u32 udcicr0 = udc_readl(udc, UDCICR0);
440 u32 udcicr1 = udc_readl(udc, UDCICR1);
441
442 if (index < 16)
443 udc_writel(udc, UDCICR0, udcicr0 & ~(3 << (index * 2)));
444 else
445 udc_writel(udc, UDCICR1, udcicr1 & ~(3 << ((index - 16) * 2)));
446}
447
448/**
449 * udc_set_mask_UDCCR - set bits in UDCCR
450 * @udc: udc device
451 * @mask: bits to set in UDCCR
452 *
453 * Sets bits in UDCCR, leaving DME and FST bits as they were.
454 */
455static inline void udc_set_mask_UDCCR(struct pxa_udc *udc, int mask)
456{
457 u32 udccr = udc_readl(udc, UDCCR);
458 udc_writel(udc, UDCCR,
459 (udccr & UDCCR_MASK_BITS) | (mask & UDCCR_MASK_BITS));
460}
461
462/**
463 * udc_clear_mask_UDCCR - clears bits in UDCCR
464 * @udc: udc device
465 * @mask: bit to clear in UDCCR
466 *
467 * Clears bits in UDCCR, leaving DME and FST bits as they were.
468 */
469static inline void udc_clear_mask_UDCCR(struct pxa_udc *udc, int mask)
470{
471 u32 udccr = udc_readl(udc, UDCCR);
472 udc_writel(udc, UDCCR,
473 (udccr & UDCCR_MASK_BITS) & ~(mask & UDCCR_MASK_BITS));
474}
475
476/**
477 * ep_count_bytes_remain - get how many bytes in udc endpoint
478 * @ep: udc endpoint
479 *
480 * Returns number of bytes in OUT fifos. Broken for IN fifos (-EOPNOTSUPP)
481 */
482static int ep_count_bytes_remain(struct pxa_ep *ep)
483{
484 if (ep->dir_in)
485 return -EOPNOTSUPP;
486 return udc_ep_readl(ep, UDCBCR) & 0x3ff;
487}
488
489/**
490 * ep_is_empty - checks if ep has byte ready for reading
491 * @ep: udc endpoint
492 *
493 * If endpoint is the control endpoint, checks if there are bytes in the
494 * control endpoint fifo. If endpoint is a data endpoint, checks if bytes
495 * are ready for reading on OUT endpoint.
496 *
497 * Returns 0 if ep not empty, 1 if ep empty, -EOPNOTSUPP if IN endpoint
498 */
499static int ep_is_empty(struct pxa_ep *ep)
500{
501 int ret;
502
503 if (!is_ep0(ep) && ep->dir_in)
504 return -EOPNOTSUPP;
505 if (is_ep0(ep))
506 ret = !(udc_ep_readl(ep, UDCCSR) & UDCCSR0_RNE);
507 else
508 ret = !(udc_ep_readl(ep, UDCCSR) & UDCCSR_BNE);
509 return ret;
510}
511
512/**
513 * ep_is_full - checks if ep has place to write bytes
514 * @ep: udc endpoint
515 *
516 * If endpoint is not the control endpoint and is an IN endpoint, checks if
517 * there is place to write bytes into the endpoint.
518 *
519 * Returns 0 if ep not full, 1 if ep full, -EOPNOTSUPP if OUT endpoint
520 */
521static int ep_is_full(struct pxa_ep *ep)
522{
523 if (is_ep0(ep))
524 return (udc_ep_readl(ep, UDCCSR) & UDCCSR0_IPR);
525 if (!ep->dir_in)
526 return -EOPNOTSUPP;
527 return (!(udc_ep_readl(ep, UDCCSR) & UDCCSR_BNF));
528}
529
530/**
531 * epout_has_pkt - checks if OUT endpoint fifo has a packet available
532 * @ep: pxa endpoint
533 *
534 * Returns 1 if a complete packet is available, 0 if not, -EOPNOTSUPP for IN ep.
535 */
536static int epout_has_pkt(struct pxa_ep *ep)
537{
538 if (!is_ep0(ep) && ep->dir_in)
539 return -EOPNOTSUPP;
540 if (is_ep0(ep))
541 return (udc_ep_readl(ep, UDCCSR) & UDCCSR0_OPC);
542 return (udc_ep_readl(ep, UDCCSR) & UDCCSR_PC);
543}
544
545/**
546 * set_ep0state - Set ep0 automata state
547 * @dev: udc device
548 * @state: state
549 */
550static void set_ep0state(struct pxa_udc *udc, int state)
551{
552 struct pxa_ep *ep = &udc->pxa_ep[0];
553 char *old_stname = EP0_STNAME(udc);
554
555 udc->ep0state = state;
556 ep_dbg(ep, "state=%s->%s, udccsr0=0x%03x, udcbcr=%d\n", old_stname,
557 EP0_STNAME(udc), udc_ep_readl(ep, UDCCSR),
558 udc_ep_readl(ep, UDCBCR));
559}
560
561/**
562 * ep0_idle - Put control endpoint into idle state
563 * @dev: udc device
564 */
565static void ep0_idle(struct pxa_udc *dev)
566{
567 set_ep0state(dev, WAIT_FOR_SETUP);
568}
569
570/**
571 * inc_ep_stats_reqs - Update ep stats counts
572 * @ep: physical endpoint
573 * @req: usb request
574 * @is_in: ep direction (USB_DIR_IN or 0)
575 *
576 */
577static void inc_ep_stats_reqs(struct pxa_ep *ep, int is_in)
578{
579 if (is_in)
580 ep->stats.in_ops++;
581 else
582 ep->stats.out_ops++;
583}
584
585/**
586 * inc_ep_stats_bytes - Update ep stats counts
587 * @ep: physical endpoint
588 * @count: bytes transfered on endpoint
d75379a5
RJ
589 * @is_in: ep direction (USB_DIR_IN or 0)
590 */
591static void inc_ep_stats_bytes(struct pxa_ep *ep, int count, int is_in)
592{
593 if (is_in)
594 ep->stats.in_bytes += count;
595 else
596 ep->stats.out_bytes += count;
597}
598
599/**
600 * pxa_ep_setup - Sets up an usb physical endpoint
601 * @ep: pxa27x physical endpoint
602 *
603 * Find the physical pxa27x ep, and setup its UDCCR
604 */
605static __init void pxa_ep_setup(struct pxa_ep *ep)
606{
607 u32 new_udccr;
608
609 new_udccr = ((ep->config << UDCCONR_CN_S) & UDCCONR_CN)
610 | ((ep->interface << UDCCONR_IN_S) & UDCCONR_IN)
611 | ((ep->alternate << UDCCONR_AISN_S) & UDCCONR_AISN)
612 | ((EPADDR(ep) << UDCCONR_EN_S) & UDCCONR_EN)
613 | ((EPXFERTYPE(ep) << UDCCONR_ET_S) & UDCCONR_ET)
614 | ((ep->dir_in) ? UDCCONR_ED : 0)
615 | ((ep->fifo_size << UDCCONR_MPS_S) & UDCCONR_MPS)
616 | UDCCONR_EE;
617
618 udc_ep_writel(ep, UDCCR, new_udccr);
619}
620
621/**
622 * pxa_eps_setup - Sets up all usb physical endpoints
623 * @dev: udc device
624 *
625 * Setup all pxa physical endpoints, except ep0
626 */
627static __init void pxa_eps_setup(struct pxa_udc *dev)
628{
629 unsigned int i;
630
631 dev_dbg(dev->dev, "%s: dev=%p\n", __func__, dev);
632
633 for (i = 1; i < NR_PXA_ENDPOINTS; i++)
634 pxa_ep_setup(&dev->pxa_ep[i]);
635}
636
637/**
638 * pxa_ep_alloc_request - Allocate usb request
639 * @_ep: usb endpoint
640 * @gfp_flags:
641 *
642 * For the pxa27x, these can just wrap kmalloc/kfree. gadget drivers
643 * must still pass correctly initialized endpoints, since other controller
644 * drivers may care about how it's currently set up (dma issues etc).
645 */
646static struct usb_request *
647pxa_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
648{
649 struct pxa27x_request *req;
650
651 req = kzalloc(sizeof *req, gfp_flags);
3131f7b0 652 if (!req)
d75379a5
RJ
653 return NULL;
654
655 INIT_LIST_HEAD(&req->queue);
656 req->in_use = 0;
657 req->udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
658
659 return &req->req;
660}
661
662/**
663 * pxa_ep_free_request - Free usb request
664 * @_ep: usb endpoint
665 * @_req: usb request
666 *
667 * Wrapper around kfree to free _req
668 */
669static void pxa_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
670{
671 struct pxa27x_request *req;
672
673 req = container_of(_req, struct pxa27x_request, req);
674 WARN_ON(!list_empty(&req->queue));
675 kfree(req);
676}
677
678/**
679 * ep_add_request - add a request to the endpoint's queue
680 * @ep: usb endpoint
681 * @req: usb request
682 *
683 * Context: ep->lock held
684 *
685 * Queues the request in the endpoint's queue, and enables the interrupts
686 * on the endpoint.
687 */
688static void ep_add_request(struct pxa_ep *ep, struct pxa27x_request *req)
689{
690 if (unlikely(!req))
691 return;
692 ep_vdbg(ep, "req:%p, lg=%d, udccsr=0x%03x\n", req,
693 req->req.length, udc_ep_readl(ep, UDCCSR));
694
695 req->in_use = 1;
696 list_add_tail(&req->queue, &ep->queue);
697 pio_irq_enable(ep);
698}
699
700/**
701 * ep_del_request - removes a request from the endpoint's queue
702 * @ep: usb endpoint
703 * @req: usb request
704 *
705 * Context: ep->lock held
706 *
707 * Unqueue the request from the endpoint's queue. If there are no more requests
708 * on the endpoint, and if it's not the control endpoint, interrupts are
709 * disabled on the endpoint.
710 */
711static void ep_del_request(struct pxa_ep *ep, struct pxa27x_request *req)
712{
713 if (unlikely(!req))
714 return;
715 ep_vdbg(ep, "req:%p, lg=%d, udccsr=0x%03x\n", req,
716 req->req.length, udc_ep_readl(ep, UDCCSR));
717
718 list_del_init(&req->queue);
719 req->in_use = 0;
720 if (!is_ep0(ep) && list_empty(&ep->queue))
721 pio_irq_disable(ep);
722}
723
724/**
725 * req_done - Complete an usb request
726 * @ep: pxa physical endpoint
727 * @req: pxa request
728 * @status: usb request status sent to gadget API
729 *
730 * Context: ep->lock held
731 *
732 * Retire a pxa27x usb request. Endpoint must be locked.
733 */
734static void req_done(struct pxa_ep *ep, struct pxa27x_request *req, int status)
735{
736 ep_del_request(ep, req);
737 if (likely(req->req.status == -EINPROGRESS))
738 req->req.status = status;
739 else
740 status = req->req.status;
741
742 if (status && status != -ESHUTDOWN)
743 ep_dbg(ep, "complete req %p stat %d len %u/%u\n",
744 &req->req, status,
745 req->req.actual, req->req.length);
746
747 req->req.complete(&req->udc_usb_ep->usb_ep, &req->req);
748}
749
750/**
751 * ep_end_out_req - Ends control endpoint in request
752 * @ep: physical endpoint
753 * @req: pxa request
754 *
755 * Context: ep->lock held
756 *
757 * Ends endpoint in request (completes usb request).
758 */
759static void ep_end_out_req(struct pxa_ep *ep, struct pxa27x_request *req)
760{
761 inc_ep_stats_reqs(ep, !USB_DIR_IN);
762 req_done(ep, req, 0);
763}
764
765/**
766 * ep0_end_out_req - Ends control endpoint in request (ends data stage)
767 * @ep: physical endpoint
768 * @req: pxa request
769 *
770 * Context: ep->lock held
771 *
772 * Ends control endpoint in request (completes usb request), and puts
773 * control endpoint into idle state
774 */
775static void ep0_end_out_req(struct pxa_ep *ep, struct pxa27x_request *req)
776{
777 set_ep0state(ep->dev, OUT_STATUS_STAGE);
778 ep_end_out_req(ep, req);
779 ep0_idle(ep->dev);
780}
781
782/**
783 * ep_end_in_req - Ends endpoint out request
784 * @ep: physical endpoint
785 * @req: pxa request
786 *
787 * Context: ep->lock held
788 *
789 * Ends endpoint out request (completes usb request).
790 */
791static void ep_end_in_req(struct pxa_ep *ep, struct pxa27x_request *req)
792{
793 inc_ep_stats_reqs(ep, USB_DIR_IN);
794 req_done(ep, req, 0);
795}
796
797/**
798 * ep0_end_in_req - Ends control endpoint out request (ends data stage)
799 * @ep: physical endpoint
800 * @req: pxa request
801 *
802 * Context: ep->lock held
803 *
804 * Ends control endpoint out request (completes usb request), and puts
805 * control endpoint into status state
806 */
807static void ep0_end_in_req(struct pxa_ep *ep, struct pxa27x_request *req)
808{
809 struct pxa_udc *udc = ep->dev;
810
811 set_ep0state(udc, IN_STATUS_STAGE);
812 ep_end_in_req(ep, req);
813}
814
815/**
816 * nuke - Dequeue all requests
817 * @ep: pxa endpoint
818 * @status: usb request status
819 *
820 * Context: ep->lock held
821 *
822 * Dequeues all requests on an endpoint. As a side effect, interrupts will be
823 * disabled on that endpoint (because no more requests).
824 */
825static void nuke(struct pxa_ep *ep, int status)
826{
827 struct pxa27x_request *req;
828
829 while (!list_empty(&ep->queue)) {
830 req = list_entry(ep->queue.next, struct pxa27x_request, queue);
831 req_done(ep, req, status);
832 }
833}
834
835/**
836 * read_packet - transfer 1 packet from an OUT endpoint into request
837 * @ep: pxa physical endpoint
838 * @req: usb request
839 *
840 * Takes bytes from OUT endpoint and transfers them info the usb request.
841 * If there is less space in request than bytes received in OUT endpoint,
842 * bytes are left in the OUT endpoint.
843 *
844 * Returns how many bytes were actually transfered
845 */
846static int read_packet(struct pxa_ep *ep, struct pxa27x_request *req)
847{
848 u32 *buf;
849 int bytes_ep, bufferspace, count, i;
850
851 bytes_ep = ep_count_bytes_remain(ep);
852 bufferspace = req->req.length - req->req.actual;
853
854 buf = (u32 *)(req->req.buf + req->req.actual);
855 prefetchw(buf);
856
857 if (likely(!ep_is_empty(ep)))
858 count = min(bytes_ep, bufferspace);
859 else /* zlp */
860 count = 0;
861
862 for (i = count; i > 0; i -= 4)
863 *buf++ = udc_ep_readl(ep, UDCDR);
864 req->req.actual += count;
865
866 udc_ep_writel(ep, UDCCSR, UDCCSR_PC);
867
868 return count;
869}
870
871/**
872 * write_packet - transfer 1 packet from request into an IN endpoint
873 * @ep: pxa physical endpoint
874 * @req: usb request
875 * @max: max bytes that fit into endpoint
876 *
877 * Takes bytes from usb request, and transfers them into the physical
878 * endpoint. If there are no bytes to transfer, doesn't write anything
879 * to physical endpoint.
880 *
881 * Returns how many bytes were actually transfered.
882 */
883static int write_packet(struct pxa_ep *ep, struct pxa27x_request *req,
884 unsigned int max)
885{
886 int length, count, remain, i;
887 u32 *buf;
888 u8 *buf_8;
889
890 buf = (u32 *)(req->req.buf + req->req.actual);
891 prefetch(buf);
892
893 length = min(req->req.length - req->req.actual, max);
894 req->req.actual += length;
895
896 remain = length & 0x3;
897 count = length & ~(0x3);
898 for (i = count; i > 0 ; i -= 4)
899 udc_ep_writel(ep, UDCDR, *buf++);
900
901 buf_8 = (u8 *)buf;
902 for (i = remain; i > 0; i--)
903 udc_ep_writeb(ep, UDCDR, *buf_8++);
904
905 ep_vdbg(ep, "length=%d+%d, udccsr=0x%03x\n", count, remain,
906 udc_ep_readl(ep, UDCCSR));
907
908 return length;
909}
910
911/**
912 * read_fifo - Transfer packets from OUT endpoint into usb request
913 * @ep: pxa physical endpoint
914 * @req: usb request
915 *
916 * Context: callable when in_interrupt()
917 *
918 * Unload as many packets as possible from the fifo we use for usb OUT
919 * transfers and put them into the request. Caller should have made sure
920 * there's at least one packet ready.
921 * Doesn't complete the request, that's the caller's job
922 *
923 * Returns 1 if the request completed, 0 otherwise
924 */
925static int read_fifo(struct pxa_ep *ep, struct pxa27x_request *req)
926{
927 int count, is_short, completed = 0;
928
929 while (epout_has_pkt(ep)) {
930 count = read_packet(ep, req);
931 inc_ep_stats_bytes(ep, count, !USB_DIR_IN);
932
933 is_short = (count < ep->fifo_size);
934 ep_dbg(ep, "read udccsr:%03x, count:%d bytes%s req %p %d/%d\n",
935 udc_ep_readl(ep, UDCCSR), count, is_short ? "/S" : "",
936 &req->req, req->req.actual, req->req.length);
937
938 /* completion */
939 if (is_short || req->req.actual == req->req.length) {
940 completed = 1;
941 break;
942 }
943 /* finished that packet. the next one may be waiting... */
944 }
945 return completed;
946}
947
948/**
949 * write_fifo - transfer packets from usb request into an IN endpoint
950 * @ep: pxa physical endpoint
951 * @req: pxa usb request
952 *
953 * Write to an IN endpoint fifo, as many packets as possible.
954 * irqs will use this to write the rest later.
955 * caller guarantees at least one packet buffer is ready (or a zlp).
956 * Doesn't complete the request, that's the caller's job
957 *
958 * Returns 1 if request fully transfered, 0 if partial transfer
959 */
960static int write_fifo(struct pxa_ep *ep, struct pxa27x_request *req)
961{
962 unsigned max;
963 int count, is_short, is_last = 0, completed = 0, totcount = 0;
964 u32 udccsr;
965
966 max = ep->fifo_size;
967 do {
968 is_short = 0;
969
970 udccsr = udc_ep_readl(ep, UDCCSR);
971 if (udccsr & UDCCSR_PC) {
972 ep_vdbg(ep, "Clearing Transmit Complete, udccsr=%x\n",
973 udccsr);
974 udc_ep_writel(ep, UDCCSR, UDCCSR_PC);
975 }
976 if (udccsr & UDCCSR_TRN) {
977 ep_vdbg(ep, "Clearing Underrun on, udccsr=%x\n",
978 udccsr);
979 udc_ep_writel(ep, UDCCSR, UDCCSR_TRN);
980 }
981
982 count = write_packet(ep, req, max);
983 inc_ep_stats_bytes(ep, count, USB_DIR_IN);
984 totcount += count;
985
986 /* last packet is usually short (or a zlp) */
987 if (unlikely(count < max)) {
988 is_last = 1;
989 is_short = 1;
990 } else {
991 if (likely(req->req.length > req->req.actual)
992 || req->req.zero)
993 is_last = 0;
994 else
995 is_last = 1;
996 /* interrupt/iso maxpacket may not fill the fifo */
997 is_short = unlikely(max < ep->fifo_size);
998 }
999
1000 if (is_short)
1001 udc_ep_writel(ep, UDCCSR, UDCCSR_SP);
1002
1003 /* requests complete when all IN data is in the FIFO */
1004 if (is_last) {
1005 completed = 1;
1006 break;
1007 }
1008 } while (!ep_is_full(ep));
1009
1010 ep_dbg(ep, "wrote count:%d bytes%s%s, left:%d req=%p\n",
1011 totcount, is_last ? "/L" : "", is_short ? "/S" : "",
1012 req->req.length - req->req.actual, &req->req);
1013
1014 return completed;
1015}
1016
1017/**
1018 * read_ep0_fifo - Transfer packets from control endpoint into usb request
1019 * @ep: control endpoint
1020 * @req: pxa usb request
1021 *
1022 * Special ep0 version of the above read_fifo. Reads as many bytes from control
1023 * endpoint as can be read, and stores them into usb request (limited by request
1024 * maximum length).
1025 *
1026 * Returns 0 if usb request only partially filled, 1 if fully filled
1027 */
1028static int read_ep0_fifo(struct pxa_ep *ep, struct pxa27x_request *req)
1029{
1030 int count, is_short, completed = 0;
1031
1032 while (epout_has_pkt(ep)) {
1033 count = read_packet(ep, req);
1034 udc_ep_writel(ep, UDCCSR, UDCCSR0_OPC);
1035 inc_ep_stats_bytes(ep, count, !USB_DIR_IN);
1036
1037 is_short = (count < ep->fifo_size);
1038 ep_dbg(ep, "read udccsr:%03x, count:%d bytes%s req %p %d/%d\n",
1039 udc_ep_readl(ep, UDCCSR), count, is_short ? "/S" : "",
1040 &req->req, req->req.actual, req->req.length);
1041
1042 if (is_short || req->req.actual >= req->req.length) {
1043 completed = 1;
1044 break;
1045 }
1046 }
1047
1048 return completed;
1049}
1050
1051/**
1052 * write_ep0_fifo - Send a request to control endpoint (ep0 in)
1053 * @ep: control endpoint
1054 * @req: request
1055 *
1056 * Context: callable when in_interrupt()
1057 *
1058 * Sends a request (or a part of the request) to the control endpoint (ep0 in).
1059 * If the request doesn't fit, the remaining part will be sent from irq.
1060 * The request is considered fully written only if either :
1061 * - last write transfered all remaining bytes, but fifo was not fully filled
1062 * - last write was a 0 length write
1063 *
1064 * Returns 1 if request fully written, 0 if request only partially sent
1065 */
1066static int write_ep0_fifo(struct pxa_ep *ep, struct pxa27x_request *req)
1067{
1068 unsigned count;
1069 int is_last, is_short;
1070
1071 count = write_packet(ep, req, EP0_FIFO_SIZE);
1072 inc_ep_stats_bytes(ep, count, USB_DIR_IN);
1073
1074 is_short = (count < EP0_FIFO_SIZE);
1075 is_last = ((count == 0) || (count < EP0_FIFO_SIZE));
1076
1077 /* Sends either a short packet or a 0 length packet */
1078 if (unlikely(is_short))
1079 udc_ep_writel(ep, UDCCSR, UDCCSR0_IPR);
1080
1081 ep_dbg(ep, "in %d bytes%s%s, %d left, req=%p, udccsr0=0x%03x\n",
1082 count, is_short ? "/S" : "", is_last ? "/L" : "",
1083 req->req.length - req->req.actual,
1084 &req->req, udc_ep_readl(ep, UDCCSR));
1085
1086 return is_last;
1087}
1088
1089/**
1090 * pxa_ep_queue - Queue a request into an IN endpoint
1091 * @_ep: usb endpoint
1092 * @_req: usb request
1093 * @gfp_flags: flags
1094 *
1095 * Context: normally called when !in_interrupt, but callable when in_interrupt()
1096 * in the special case of ep0 setup :
1097 * (irq->handle_ep0_ctrl_req->gadget_setup->pxa_ep_queue)
1098 *
1099 * Returns 0 if succedeed, error otherwise
1100 */
1101static int pxa_ep_queue(struct usb_ep *_ep, struct usb_request *_req,
1102 gfp_t gfp_flags)
1103{
1104 struct udc_usb_ep *udc_usb_ep;
1105 struct pxa_ep *ep;
1106 struct pxa27x_request *req;
1107 struct pxa_udc *dev;
1108 unsigned long flags;
1109 int rc = 0;
1110 int is_first_req;
1111 unsigned length;
1112
1113 req = container_of(_req, struct pxa27x_request, req);
1114 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1115
1116 if (unlikely(!_req || !_req->complete || !_req->buf))
1117 return -EINVAL;
1118
1119 if (unlikely(!_ep))
1120 return -EINVAL;
1121
1122 dev = udc_usb_ep->dev;
1123 ep = udc_usb_ep->pxa_ep;
1124 if (unlikely(!ep))
1125 return -EINVAL;
1126
1127 dev = ep->dev;
1128 if (unlikely(!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)) {
1129 ep_dbg(ep, "bogus device state\n");
1130 return -ESHUTDOWN;
1131 }
1132
1133 /* iso is always one packet per request, that's the only way
1134 * we can report per-packet status. that also helps with dma.
1135 */
1136 if (unlikely(EPXFERTYPE_is_ISO(ep)
1137 && req->req.length > ep->fifo_size))
1138 return -EMSGSIZE;
1139
1140 spin_lock_irqsave(&ep->lock, flags);
1141
1142 is_first_req = list_empty(&ep->queue);
1143 ep_dbg(ep, "queue req %p(first=%s), len %d buf %p\n",
1144 _req, is_first_req ? "yes" : "no",
1145 _req->length, _req->buf);
1146
1147 if (!ep->enabled) {
1148 _req->status = -ESHUTDOWN;
1149 rc = -ESHUTDOWN;
1150 goto out;
1151 }
1152
1153 if (req->in_use) {
1154 ep_err(ep, "refusing to queue req %p (already queued)\n", req);
1155 goto out;
1156 }
1157
1158 length = _req->length;
1159 _req->status = -EINPROGRESS;
1160 _req->actual = 0;
1161
1162 ep_add_request(ep, req);
1163
1164 if (is_ep0(ep)) {
1165 switch (dev->ep0state) {
1166 case WAIT_ACK_SET_CONF_INTERF:
1167 if (length == 0) {
1168 ep_end_in_req(ep, req);
1169 } else {
1170 ep_err(ep, "got a request of %d bytes while"
1171 "in state WATI_ACK_SET_CONF_INTERF\n",
1172 length);
1173 ep_del_request(ep, req);
1174 rc = -EL2HLT;
1175 }
1176 ep0_idle(ep->dev);
1177 break;
1178 case IN_DATA_STAGE:
1179 if (!ep_is_full(ep))
1180 if (write_ep0_fifo(ep, req))
1181 ep0_end_in_req(ep, req);
1182 break;
1183 case OUT_DATA_STAGE:
1184 if ((length == 0) || !epout_has_pkt(ep))
1185 if (read_ep0_fifo(ep, req))
1186 ep0_end_out_req(ep, req);
1187 break;
1188 default:
1189 ep_err(ep, "odd state %s to send me a request\n",
1190 EP0_STNAME(ep->dev));
1191 ep_del_request(ep, req);
1192 rc = -EL2HLT;
1193 break;
1194 }
1195 } else {
1196 handle_ep(ep);
1197 }
1198
1199out:
1200 spin_unlock_irqrestore(&ep->lock, flags);
1201 return rc;
1202}
1203
1204/**
1205 * pxa_ep_dequeue - Dequeue one request
1206 * @_ep: usb endpoint
1207 * @_req: usb request
1208 *
1209 * Return 0 if no error, -EINVAL or -ECONNRESET otherwise
1210 */
1211static int pxa_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1212{
1213 struct pxa_ep *ep;
1214 struct udc_usb_ep *udc_usb_ep;
1215 struct pxa27x_request *req;
1216 unsigned long flags;
1217 int rc;
1218
1219 if (!_ep)
1220 return -EINVAL;
1221 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1222 ep = udc_usb_ep->pxa_ep;
1223 if (!ep || is_ep0(ep))
1224 return -EINVAL;
1225
1226 spin_lock_irqsave(&ep->lock, flags);
1227
1228 /* make sure it's actually queued on this endpoint */
1229 list_for_each_entry(req, &ep->queue, queue) {
1230 if (&req->req == _req)
1231 break;
1232 }
1233
1234 rc = -EINVAL;
1235 if (&req->req != _req)
1236 goto out;
1237
1238 rc = 0;
1239 req_done(ep, req, -ECONNRESET);
1240out:
1241 spin_unlock_irqrestore(&ep->lock, flags);
1242 return rc;
1243}
1244
1245/**
1246 * pxa_ep_set_halt - Halts operations on one endpoint
1247 * @_ep: usb endpoint
1248 * @value:
1249 *
1250 * Returns 0 if no error, -EINVAL, -EROFS, -EAGAIN otherwise
1251 */
1252static int pxa_ep_set_halt(struct usb_ep *_ep, int value)
1253{
1254 struct pxa_ep *ep;
1255 struct udc_usb_ep *udc_usb_ep;
1256 unsigned long flags;
1257 int rc;
1258
1259
1260 if (!_ep)
1261 return -EINVAL;
1262 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1263 ep = udc_usb_ep->pxa_ep;
1264 if (!ep || is_ep0(ep))
1265 return -EINVAL;
1266
1267 if (value == 0) {
1268 /*
1269 * This path (reset toggle+halt) is needed to implement
1270 * SET_INTERFACE on normal hardware. but it can't be
1271 * done from software on the PXA UDC, and the hardware
1272 * forgets to do it as part of SET_INTERFACE automagic.
1273 */
1274 ep_dbg(ep, "only host can clear halt\n");
1275 return -EROFS;
1276 }
1277
1278 spin_lock_irqsave(&ep->lock, flags);
1279
1280 rc = -EAGAIN;
1281 if (ep->dir_in && (ep_is_full(ep) || !list_empty(&ep->queue)))
1282 goto out;
1283
1284 /* FST, FEF bits are the same for control and non control endpoints */
1285 rc = 0;
1286 udc_ep_writel(ep, UDCCSR, UDCCSR_FST | UDCCSR_FEF);
1287 if (is_ep0(ep))
1288 set_ep0state(ep->dev, STALL);
1289
1290out:
1291 spin_unlock_irqrestore(&ep->lock, flags);
1292 return rc;
1293}
1294
1295/**
1296 * pxa_ep_fifo_status - Get how many bytes in physical endpoint
1297 * @_ep: usb endpoint
1298 *
1299 * Returns number of bytes in OUT fifos. Broken for IN fifos.
1300 */
1301static int pxa_ep_fifo_status(struct usb_ep *_ep)
1302{
1303 struct pxa_ep *ep;
1304 struct udc_usb_ep *udc_usb_ep;
1305
1306 if (!_ep)
1307 return -ENODEV;
1308 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1309 ep = udc_usb_ep->pxa_ep;
1310 if (!ep || is_ep0(ep))
1311 return -ENODEV;
1312
1313 if (ep->dir_in)
1314 return -EOPNOTSUPP;
1315 if (ep->dev->gadget.speed == USB_SPEED_UNKNOWN || ep_is_empty(ep))
1316 return 0;
1317 else
1318 return ep_count_bytes_remain(ep) + 1;
1319}
1320
1321/**
1322 * pxa_ep_fifo_flush - Flushes one endpoint
1323 * @_ep: usb endpoint
1324 *
1325 * Discards all data in one endpoint(IN or OUT), except control endpoint.
1326 */
1327static void pxa_ep_fifo_flush(struct usb_ep *_ep)
1328{
1329 struct pxa_ep *ep;
1330 struct udc_usb_ep *udc_usb_ep;
1331 unsigned long flags;
1332
1333 if (!_ep)
1334 return;
1335 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1336 ep = udc_usb_ep->pxa_ep;
1337 if (!ep || is_ep0(ep))
1338 return;
1339
1340 spin_lock_irqsave(&ep->lock, flags);
1341
1342 if (unlikely(!list_empty(&ep->queue)))
1343 ep_dbg(ep, "called while queue list not empty\n");
1344 ep_dbg(ep, "called\n");
1345
1346 /* for OUT, just read and discard the FIFO contents. */
1347 if (!ep->dir_in) {
1348 while (!ep_is_empty(ep))
1349 udc_ep_readl(ep, UDCDR);
1350 } else {
1351 /* most IN status is the same, but ISO can't stall */
1352 udc_ep_writel(ep, UDCCSR,
1353 UDCCSR_PC | UDCCSR_FEF | UDCCSR_TRN
1354 | (EPXFERTYPE_is_ISO(ep) ? 0 : UDCCSR_SST));
1355 }
1356
1357 spin_unlock_irqrestore(&ep->lock, flags);
1358
1359 return;
1360}
1361
1362/**
1363 * pxa_ep_enable - Enables usb endpoint
1364 * @_ep: usb endpoint
1365 * @desc: usb endpoint descriptor
1366 *
1367 * Nothing much to do here, as ep configuration is done once and for all
1368 * before udc is enabled. After udc enable, no physical endpoint configuration
1369 * can be changed.
1370 * Function makes sanity checks and flushes the endpoint.
1371 */
1372static int pxa_ep_enable(struct usb_ep *_ep,
1373 const struct usb_endpoint_descriptor *desc)
1374{
1375 struct pxa_ep *ep;
1376 struct udc_usb_ep *udc_usb_ep;
1377 struct pxa_udc *udc;
1378
1379 if (!_ep || !desc)
1380 return -EINVAL;
1381
1382 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1383 if (udc_usb_ep->pxa_ep) {
1384 ep = udc_usb_ep->pxa_ep;
1385 ep_warn(ep, "usb_ep %s already enabled, doing nothing\n",
1386 _ep->name);
1387 } else {
1388 ep = find_pxa_ep(udc_usb_ep->dev, udc_usb_ep);
1389 }
1390
1391 if (!ep || is_ep0(ep)) {
1392 dev_err(udc_usb_ep->dev->dev,
1393 "unable to match pxa_ep for ep %s\n",
1394 _ep->name);
1395 return -EINVAL;
1396 }
1397
1398 if ((desc->bDescriptorType != USB_DT_ENDPOINT)
1399 || (ep->type != usb_endpoint_type(desc))) {
1400 ep_err(ep, "type mismatch\n");
1401 return -EINVAL;
1402 }
1403
1404 if (ep->fifo_size < le16_to_cpu(desc->wMaxPacketSize)) {
1405 ep_err(ep, "bad maxpacket\n");
1406 return -ERANGE;
1407 }
1408
1409 udc_usb_ep->pxa_ep = ep;
1410 udc = ep->dev;
1411
1412 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
1413 ep_err(ep, "bogus device state\n");
1414 return -ESHUTDOWN;
1415 }
1416
1417 ep->enabled = 1;
1418
1419 /* flush fifo (mostly for OUT buffers) */
1420 pxa_ep_fifo_flush(_ep);
1421
1422 ep_dbg(ep, "enabled\n");
1423 return 0;
1424}
1425
1426/**
1427 * pxa_ep_disable - Disable usb endpoint
1428 * @_ep: usb endpoint
1429 *
1430 * Same as for pxa_ep_enable, no physical endpoint configuration can be
1431 * changed.
1432 * Function flushes the endpoint and related requests.
1433 */
1434static int pxa_ep_disable(struct usb_ep *_ep)
1435{
1436 struct pxa_ep *ep;
1437 struct udc_usb_ep *udc_usb_ep;
1438 unsigned long flags;
1439
1440 if (!_ep)
1441 return -EINVAL;
1442
1443 udc_usb_ep = container_of(_ep, struct udc_usb_ep, usb_ep);
1444 ep = udc_usb_ep->pxa_ep;
1445 if (!ep || is_ep0(ep) || !list_empty(&ep->queue))
1446 return -EINVAL;
1447
1448 spin_lock_irqsave(&ep->lock, flags);
1449 ep->enabled = 0;
1450 nuke(ep, -ESHUTDOWN);
1451 spin_unlock_irqrestore(&ep->lock, flags);
1452
1453 pxa_ep_fifo_flush(_ep);
1454 udc_usb_ep->pxa_ep = NULL;
1455
1456 ep_dbg(ep, "disabled\n");
1457 return 0;
1458}
1459
1460static struct usb_ep_ops pxa_ep_ops = {
1461 .enable = pxa_ep_enable,
1462 .disable = pxa_ep_disable,
1463
1464 .alloc_request = pxa_ep_alloc_request,
1465 .free_request = pxa_ep_free_request,
1466
1467 .queue = pxa_ep_queue,
1468 .dequeue = pxa_ep_dequeue,
1469
1470 .set_halt = pxa_ep_set_halt,
1471 .fifo_status = pxa_ep_fifo_status,
1472 .fifo_flush = pxa_ep_fifo_flush,
1473};
1474
eb507025
RJ
1475/**
1476 * dplus_pullup - Connect or disconnect pullup resistor to D+ pin
1477 * @udc: udc device
1478 * @on: 0 if disconnect pullup resistor, 1 otherwise
1479 * Context: any
1480 *
1481 * Handle D+ pullup resistor, make the device visible to the usb bus, and
1482 * declare it as a full speed usb device
1483 */
1484static void dplus_pullup(struct pxa_udc *udc, int on)
1485{
1486 if (on) {
1487 if (gpio_is_valid(udc->mach->gpio_pullup))
1488 gpio_set_value(udc->mach->gpio_pullup,
1489 !udc->mach->gpio_pullup_inverted);
1490 if (udc->mach->udc_command)
1491 udc->mach->udc_command(PXA2XX_UDC_CMD_CONNECT);
1492 } else {
1493 if (gpio_is_valid(udc->mach->gpio_pullup))
1494 gpio_set_value(udc->mach->gpio_pullup,
1495 udc->mach->gpio_pullup_inverted);
1496 if (udc->mach->udc_command)
1497 udc->mach->udc_command(PXA2XX_UDC_CMD_DISCONNECT);
1498 }
1499 udc->pullup_on = on;
1500}
d75379a5
RJ
1501
1502/**
1503 * pxa_udc_get_frame - Returns usb frame number
1504 * @_gadget: usb gadget
1505 */
1506static int pxa_udc_get_frame(struct usb_gadget *_gadget)
1507{
1508 struct pxa_udc *udc = to_gadget_udc(_gadget);
1509
1510 return (udc_readl(udc, UDCFNR) & 0x7ff);
1511}
1512
1513/**
1514 * pxa_udc_wakeup - Force udc device out of suspend
1515 * @_gadget: usb gadget
1516 *
1517 * Returns 0 if succesfull, error code otherwise
1518 */
1519static int pxa_udc_wakeup(struct usb_gadget *_gadget)
1520{
1521 struct pxa_udc *udc = to_gadget_udc(_gadget);
1522
1523 /* host may not have enabled remote wakeup */
1524 if ((udc_readl(udc, UDCCR) & UDCCR_DWRE) == 0)
1525 return -EHOSTUNREACH;
1526 udc_set_mask_UDCCR(udc, UDCCR_UDR);
1527 return 0;
1528}
1529
eb507025
RJ
1530static void udc_enable(struct pxa_udc *udc);
1531static void udc_disable(struct pxa_udc *udc);
1532
1533/**
1534 * should_enable_udc - Tells if UDC should be enabled
1535 * @udc: udc device
1536 * Context: any
1537 *
1538 * The UDC should be enabled if :
b799a7eb 1539
eb507025
RJ
1540 * - the pullup resistor is connected
1541 * - and a gadget driver is bound
b799a7eb 1542 * - and vbus is sensed (or no vbus sense is available)
eb507025
RJ
1543 *
1544 * Returns 1 if UDC should be enabled, 0 otherwise
1545 */
1546static int should_enable_udc(struct pxa_udc *udc)
1547{
1548 int put_on;
1549
1550 put_on = ((udc->pullup_on) && (udc->driver));
b799a7eb 1551 put_on &= ((udc->vbus_sensed) || (!udc->transceiver));
eb507025
RJ
1552 return put_on;
1553}
1554
1555/**
1556 * should_disable_udc - Tells if UDC should be disabled
1557 * @udc: udc device
1558 * Context: any
1559 *
1560 * The UDC should be disabled if :
1561 * - the pullup resistor is not connected
1562 * - or no gadget driver is bound
b799a7eb 1563 * - or no vbus is sensed (when vbus sesing is available)
eb507025
RJ
1564 *
1565 * Returns 1 if UDC should be disabled
1566 */
1567static int should_disable_udc(struct pxa_udc *udc)
1568{
1569 int put_off;
1570
1571 put_off = ((!udc->pullup_on) || (!udc->driver));
b799a7eb 1572 put_off |= ((!udc->vbus_sensed) && (udc->transceiver));
eb507025
RJ
1573 return put_off;
1574}
1575
1576/**
1577 * pxa_udc_pullup - Offer manual D+ pullup control
1578 * @_gadget: usb gadget using the control
1579 * @is_active: 0 if disconnect, else connect D+ pullup resistor
1580 * Context: !in_interrupt()
1581 *
1582 * Returns 0 if OK, -EOPNOTSUPP if udc driver doesn't handle D+ pullup
1583 */
1584static int pxa_udc_pullup(struct usb_gadget *_gadget, int is_active)
1585{
1586 struct pxa_udc *udc = to_gadget_udc(_gadget);
1587
1588 if (!gpio_is_valid(udc->mach->gpio_pullup) && !udc->mach->udc_command)
1589 return -EOPNOTSUPP;
1590
1591 dplus_pullup(udc, is_active);
1592
1593 if (should_enable_udc(udc))
1594 udc_enable(udc);
1595 if (should_disable_udc(udc))
1596 udc_disable(udc);
1597 return 0;
1598}
1599
b799a7eb
RJ
1600static void udc_enable(struct pxa_udc *udc);
1601static void udc_disable(struct pxa_udc *udc);
1602
1603/**
1604 * pxa_udc_vbus_session - Called by external transceiver to enable/disable udc
1605 * @_gadget: usb gadget
1606 * @is_active: 0 if should disable the udc, 1 if should enable
1607 *
1608 * Enables the udc, and optionnaly activates D+ pullup resistor. Or disables the
1609 * udc, and deactivates D+ pullup resistor.
1610 *
1611 * Returns 0
1612 */
1613static int pxa_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1614{
1615 struct pxa_udc *udc = to_gadget_udc(_gadget);
1616
1617 udc->vbus_sensed = is_active;
1618 if (should_enable_udc(udc))
1619 udc_enable(udc);
1620 if (should_disable_udc(udc))
1621 udc_disable(udc);
1622
1623 return 0;
1624}
1625
d75379a5
RJ
1626static const struct usb_gadget_ops pxa_udc_ops = {
1627 .get_frame = pxa_udc_get_frame,
1628 .wakeup = pxa_udc_wakeup,
eb507025 1629 .pullup = pxa_udc_pullup,
b799a7eb 1630 .vbus_session = pxa_udc_vbus_session,
d75379a5
RJ
1631 /* current versions must always be self-powered */
1632};
1633
1634/**
1635 * udc_disable - disable udc device controller
1636 * @udc: udc device
eb507025 1637 * Context: any
d75379a5
RJ
1638 *
1639 * Disables the udc device : disables clocks, udc interrupts, control endpoint
1640 * interrupts.
1641 */
1642static void udc_disable(struct pxa_udc *udc)
1643{
eb507025
RJ
1644 if (!udc->enabled)
1645 return;
1646
d75379a5
RJ
1647 udc_writel(udc, UDCICR0, 0);
1648 udc_writel(udc, UDCICR1, 0);
1649
1650 udc_clear_mask_UDCCR(udc, UDCCR_UDE);
1651 clk_disable(udc->clk);
1652
1653 ep0_idle(udc);
1654 udc->gadget.speed = USB_SPEED_UNKNOWN;
eb507025
RJ
1655
1656 udc->enabled = 0;
d75379a5
RJ
1657}
1658
1659/**
1660 * udc_init_data - Initialize udc device data structures
1661 * @dev: udc device
1662 *
1663 * Initializes gadget endpoint list, endpoints locks. No action is taken
1664 * on the hardware.
1665 */
1666static __init void udc_init_data(struct pxa_udc *dev)
1667{
1668 int i;
1669 struct pxa_ep *ep;
1670
1671 /* device/ep0 records init */
1672 INIT_LIST_HEAD(&dev->gadget.ep_list);
1673 INIT_LIST_HEAD(&dev->gadget.ep0->ep_list);
1674 dev->udc_usb_ep[0].pxa_ep = &dev->pxa_ep[0];
1675 ep0_idle(dev);
d75379a5
RJ
1676
1677 /* PXA endpoints init */
1678 for (i = 0; i < NR_PXA_ENDPOINTS; i++) {
1679 ep = &dev->pxa_ep[i];
1680
1681 ep->enabled = is_ep0(ep);
1682 INIT_LIST_HEAD(&ep->queue);
1683 spin_lock_init(&ep->lock);
1684 }
1685
1686 /* USB endpoints init */
1687 for (i = 0; i < NR_USB_ENDPOINTS; i++)
1688 if (i != 0)
1689 list_add_tail(&dev->udc_usb_ep[i].usb_ep.ep_list,
1690 &dev->gadget.ep_list);
1691}
1692
1693/**
1694 * udc_enable - Enables the udc device
1695 * @dev: udc device
1696 *
1697 * Enables the udc device : enables clocks, udc interrupts, control endpoint
1698 * interrupts, sets usb as UDC client and setups endpoints.
1699 */
1700static void udc_enable(struct pxa_udc *udc)
1701{
eb507025
RJ
1702 if (udc->enabled)
1703 return;
1704
d75379a5
RJ
1705 udc_writel(udc, UDCICR0, 0);
1706 udc_writel(udc, UDCICR1, 0);
d75379a5
RJ
1707 udc_clear_mask_UDCCR(udc, UDCCR_UDE);
1708
1709 clk_enable(udc->clk);
1710
1711 ep0_idle(udc);
1712 udc->gadget.speed = USB_SPEED_FULL;
1713 memset(&udc->stats, 0, sizeof(udc->stats));
1714
1715 udc_set_mask_UDCCR(udc, UDCCR_UDE);
1716 udelay(2);
1717 if (udc_readl(udc, UDCCR) & UDCCR_EMCE)
1718 dev_err(udc->dev, "Configuration errors, udc disabled\n");
1719
1720 /*
1721 * Caller must be able to sleep in order to cope with startup transients
1722 */
1723 msleep(100);
1724
1725 /* enable suspend/resume and reset irqs */
1726 udc_writel(udc, UDCICR1,
1727 UDCICR1_IECC | UDCICR1_IERU
1728 | UDCICR1_IESU | UDCICR1_IERS);
1729
1730 /* enable ep0 irqs */
1731 pio_irq_enable(&udc->pxa_ep[0]);
1732
eb507025 1733 udc->enabled = 1;
d75379a5
RJ
1734}
1735
1736/**
1737 * usb_gadget_register_driver - Register gadget driver
1738 * @driver: gadget driver
1739 *
1740 * When a driver is successfully registered, it will receive control requests
1741 * including set_configuration(), which enables non-control requests. Then
1742 * usb traffic follows until a disconnect is reported. Then a host may connect
1743 * again, or the driver might get unbound.
1744 *
eb507025
RJ
1745 * Note that the udc is not automatically enabled. Check function
1746 * should_enable_udc().
1747 *
d75379a5
RJ
1748 * Returns 0 if no error, -EINVAL, -ENODEV, -EBUSY otherwise
1749 */
1750int usb_gadget_register_driver(struct usb_gadget_driver *driver)
1751{
1752 struct pxa_udc *udc = the_controller;
1753 int retval;
1754
bf31338b 1755 if (!driver || driver->speed < USB_SPEED_FULL || !driver->bind
d75379a5
RJ
1756 || !driver->disconnect || !driver->setup)
1757 return -EINVAL;
1758 if (!udc)
1759 return -ENODEV;
1760 if (udc->driver)
1761 return -EBUSY;
1762
1763 /* first hook up the driver ... */
1764 udc->driver = driver;
1765 udc->gadget.dev.driver = &driver->driver;
eb507025 1766 dplus_pullup(udc, 1);
d75379a5
RJ
1767
1768 retval = device_add(&udc->gadget.dev);
1769 if (retval) {
1770 dev_err(udc->dev, "device_add error %d\n", retval);
1771 goto add_fail;
1772 }
1773 retval = driver->bind(&udc->gadget);
1774 if (retval) {
1775 dev_err(udc->dev, "bind to driver %s --> error %d\n",
1776 driver->driver.name, retval);
1777 goto bind_fail;
1778 }
1779 dev_dbg(udc->dev, "registered gadget driver '%s'\n",
1780 driver->driver.name);
1781
7fec3c25
RJ
1782 if (udc->transceiver) {
1783 retval = otg_set_peripheral(udc->transceiver, &udc->gadget);
1784 if (retval) {
1785 dev_err(udc->dev, "can't bind to transceiver\n");
1786 goto transceiver_fail;
1787 }
1788 }
1789
eb507025
RJ
1790 if (should_enable_udc(udc))
1791 udc_enable(udc);
d75379a5
RJ
1792 return 0;
1793
7fec3c25
RJ
1794transceiver_fail:
1795 if (driver->unbind)
1796 driver->unbind(&udc->gadget);
d75379a5
RJ
1797bind_fail:
1798 device_del(&udc->gadget.dev);
1799add_fail:
1800 udc->driver = NULL;
1801 udc->gadget.dev.driver = NULL;
1802 return retval;
1803}
1804EXPORT_SYMBOL(usb_gadget_register_driver);
1805
1806
1807/**
1808 * stop_activity - Stops udc endpoints
1809 * @udc: udc device
1810 * @driver: gadget driver
1811 *
1812 * Disables all udc endpoints (even control endpoint), report disconnect to
1813 * the gadget user.
1814 */
1815static void stop_activity(struct pxa_udc *udc, struct usb_gadget_driver *driver)
1816{
1817 int i;
1818
1819 /* don't disconnect drivers more than once */
1820 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
1821 driver = NULL;
1822 udc->gadget.speed = USB_SPEED_UNKNOWN;
1823
1824 for (i = 0; i < NR_USB_ENDPOINTS; i++)
1825 pxa_ep_disable(&udc->udc_usb_ep[i].usb_ep);
1826
1827 if (driver)
1828 driver->disconnect(&udc->gadget);
1829}
1830
1831/**
1832 * usb_gadget_unregister_driver - Unregister the gadget driver
1833 * @driver: gadget driver
1834 *
1835 * Returns 0 if no error, -ENODEV, -EINVAL otherwise
1836 */
1837int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
1838{
1839 struct pxa_udc *udc = the_controller;
1840
1841 if (!udc)
1842 return -ENODEV;
1843 if (!driver || driver != udc->driver || !driver->unbind)
1844 return -EINVAL;
1845
1846 stop_activity(udc, driver);
1847 udc_disable(udc);
eb507025 1848 dplus_pullup(udc, 0);
d75379a5
RJ
1849
1850 driver->unbind(&udc->gadget);
1851 udc->driver = NULL;
1852
1853 device_del(&udc->gadget.dev);
d75379a5
RJ
1854 dev_info(udc->dev, "unregistered gadget driver '%s'\n",
1855 driver->driver.name);
7fec3c25
RJ
1856
1857 if (udc->transceiver)
1858 return otg_set_peripheral(udc->transceiver, NULL);
d75379a5
RJ
1859 return 0;
1860}
1861EXPORT_SYMBOL(usb_gadget_unregister_driver);
1862
1863/**
1864 * handle_ep0_ctrl_req - handle control endpoint control request
1865 * @udc: udc device
1866 * @req: control request
1867 */
1868static void handle_ep0_ctrl_req(struct pxa_udc *udc,
1869 struct pxa27x_request *req)
1870{
1871 struct pxa_ep *ep = &udc->pxa_ep[0];
1872 union {
1873 struct usb_ctrlrequest r;
1874 u32 word[2];
1875 } u;
1876 int i;
1877 int have_extrabytes = 0;
1878
1879 nuke(ep, -EPROTO);
1880
1881 /* read SETUP packet */
1882 for (i = 0; i < 2; i++) {
1883 if (unlikely(ep_is_empty(ep)))
1884 goto stall;
1885 u.word[i] = udc_ep_readl(ep, UDCDR);
1886 }
1887
1888 have_extrabytes = !ep_is_empty(ep);
1889 while (!ep_is_empty(ep)) {
1890 i = udc_ep_readl(ep, UDCDR);
1891 ep_err(ep, "wrong to have extra bytes for setup : 0x%08x\n", i);
1892 }
1893
d75379a5
RJ
1894 ep_dbg(ep, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1895 u.r.bRequestType, u.r.bRequest,
5a59bc54
RJ
1896 le16_to_cpu(u.r.wValue), le16_to_cpu(u.r.wIndex),
1897 le16_to_cpu(u.r.wLength));
d75379a5
RJ
1898 if (unlikely(have_extrabytes))
1899 goto stall;
1900
1901 if (u.r.bRequestType & USB_DIR_IN)
1902 set_ep0state(udc, IN_DATA_STAGE);
1903 else
1904 set_ep0state(udc, OUT_DATA_STAGE);
1905
1906 /* Tell UDC to enter Data Stage */
1907 udc_ep_writel(ep, UDCCSR, UDCCSR0_SA | UDCCSR0_OPC);
1908
1909 i = udc->driver->setup(&udc->gadget, &u.r);
1910 if (i < 0)
1911 goto stall;
1912out:
1913 return;
1914stall:
1915 ep_dbg(ep, "protocol STALL, udccsr0=%03x err %d\n",
1916 udc_ep_readl(ep, UDCCSR), i);
1917 udc_ep_writel(ep, UDCCSR, UDCCSR0_FST | UDCCSR0_FTF);
1918 set_ep0state(udc, STALL);
1919 goto out;
1920}
1921
1922/**
1923 * handle_ep0 - Handle control endpoint data transfers
1924 * @udc: udc device
1925 * @fifo_irq: 1 if triggered by fifo service type irq
1926 * @opc_irq: 1 if triggered by output packet complete type irq
1927 *
1928 * Context : when in_interrupt() or with ep->lock held
1929 *
1930 * Tries to transfer all pending request data into the endpoint and/or
1931 * transfer all pending data in the endpoint into usb requests.
1932 * Handles states of ep0 automata.
1933 *
1934 * PXA27x hardware handles several standard usb control requests without
1935 * driver notification. The requests fully handled by hardware are :
1936 * SET_ADDRESS, SET_FEATURE, CLEAR_FEATURE, GET_CONFIGURATION, GET_INTERFACE,
1937 * GET_STATUS
1938 * The requests handled by hardware, but with irq notification are :
1939 * SYNCH_FRAME, SET_CONFIGURATION, SET_INTERFACE
1940 * The remaining standard requests really handled by handle_ep0 are :
1941 * GET_DESCRIPTOR, SET_DESCRIPTOR, specific requests.
1942 * Requests standardized outside of USB 2.0 chapter 9 are handled more
1943 * uniformly, by gadget drivers.
1944 *
1945 * The control endpoint state machine is _not_ USB spec compliant, it's even
1946 * hardly compliant with Intel PXA270 developers guide.
1947 * The key points which inferred this state machine are :
1948 * - on every setup token, bit UDCCSR0_SA is raised and held until cleared by
1949 * software.
1950 * - on every OUT packet received, UDCCSR0_OPC is raised and held until
1951 * cleared by software.
1952 * - clearing UDCCSR0_OPC always flushes ep0. If in setup stage, never do it
1953 * before reading ep0.
1954 * - irq can be called on a "packet complete" event (opc_irq=1), while
1955 * UDCCSR0_OPC is not yet raised (delta can be as big as 100ms
1956 * from experimentation).
1957 * - as UDCCSR0_SA can be activated while in irq handling, and clearing
1958 * UDCCSR0_OPC would flush the setup data, we almost never clear UDCCSR0_OPC
1959 * => we never actually read the "status stage" packet of an IN data stage
1960 * => this is not documented in Intel documentation
1961 * - hardware as no idea of STATUS STAGE, it only handle SETUP STAGE and DATA
1962 * STAGE. The driver add STATUS STAGE to send last zero length packet in
1963 * OUT_STATUS_STAGE.
1964 * - special attention was needed for IN_STATUS_STAGE. If a packet complete
1965 * event is detected, we terminate the status stage without ackowledging the
1966 * packet (not to risk to loose a potential SETUP packet)
1967 */
1968static void handle_ep0(struct pxa_udc *udc, int fifo_irq, int opc_irq)
1969{
1970 u32 udccsr0;
1971 struct pxa_ep *ep = &udc->pxa_ep[0];
1972 struct pxa27x_request *req = NULL;
1973 int completed = 0;
1974
1975 udccsr0 = udc_ep_readl(ep, UDCCSR);
1976 ep_dbg(ep, "state=%s, req=%p, udccsr0=0x%03x, udcbcr=%d, irq_msk=%x\n",
1977 EP0_STNAME(udc), req, udccsr0, udc_ep_readl(ep, UDCBCR),
1978 (fifo_irq << 1 | opc_irq));
1979
1980 if (!list_empty(&ep->queue))
1981 req = list_entry(ep->queue.next, struct pxa27x_request, queue);
1982
1983 if (udccsr0 & UDCCSR0_SST) {
1984 ep_dbg(ep, "clearing stall status\n");
1985 nuke(ep, -EPIPE);
1986 udc_ep_writel(ep, UDCCSR, UDCCSR0_SST);
1987 ep0_idle(udc);
1988 }
1989
1990 if (udccsr0 & UDCCSR0_SA) {
1991 nuke(ep, 0);
1992 set_ep0state(udc, SETUP_STAGE);
1993 }
1994
1995 switch (udc->ep0state) {
1996 case WAIT_FOR_SETUP:
1997 /*
1998 * Hardware bug : beware, we cannot clear OPC, since we would
1999 * miss a potential OPC irq for a setup packet.
2000 * So, we only do ... nothing, and hope for a next irq with
2001 * UDCCSR0_SA set.
2002 */
2003 break;
2004 case SETUP_STAGE:
2005 udccsr0 &= UDCCSR0_CTRL_REQ_MASK;
2006 if (likely(udccsr0 == UDCCSR0_CTRL_REQ_MASK))
2007 handle_ep0_ctrl_req(udc, req);
2008 break;
2009 case IN_DATA_STAGE: /* GET_DESCRIPTOR */
2010 if (epout_has_pkt(ep))
2011 udc_ep_writel(ep, UDCCSR, UDCCSR0_OPC);
2012 if (req && !ep_is_full(ep))
2013 completed = write_ep0_fifo(ep, req);
2014 if (completed)
2015 ep0_end_in_req(ep, req);
2016 break;
2017 case OUT_DATA_STAGE: /* SET_DESCRIPTOR */
2018 if (epout_has_pkt(ep) && req)
2019 completed = read_ep0_fifo(ep, req);
2020 if (completed)
2021 ep0_end_out_req(ep, req);
2022 break;
2023 case STALL:
2024 udc_ep_writel(ep, UDCCSR, UDCCSR0_FST);
2025 break;
2026 case IN_STATUS_STAGE:
2027 /*
2028 * Hardware bug : beware, we cannot clear OPC, since we would
2029 * miss a potential PC irq for a setup packet.
2030 * So, we only put the ep0 into WAIT_FOR_SETUP state.
2031 */
2032 if (opc_irq)
2033 ep0_idle(udc);
2034 break;
2035 case OUT_STATUS_STAGE:
2036 case WAIT_ACK_SET_CONF_INTERF:
2037 ep_warn(ep, "should never get in %s state here!!!\n",
2038 EP0_STNAME(ep->dev));
2039 ep0_idle(udc);
2040 break;
2041 }
2042}
2043
2044/**
2045 * handle_ep - Handle endpoint data tranfers
2046 * @ep: pxa physical endpoint
2047 *
2048 * Tries to transfer all pending request data into the endpoint and/or
2049 * transfer all pending data in the endpoint into usb requests.
2050 *
2051 * Is always called when in_interrupt() or with ep->lock held.
2052 */
2053static void handle_ep(struct pxa_ep *ep)
2054{
2055 struct pxa27x_request *req;
2056 int completed;
2057 u32 udccsr;
2058 int is_in = ep->dir_in;
2059 int loop = 0;
2060
2061 do {
2062 completed = 0;
2063 udccsr = udc_ep_readl(ep, UDCCSR);
2064 if (likely(!list_empty(&ep->queue)))
2065 req = list_entry(ep->queue.next,
2066 struct pxa27x_request, queue);
2067 else
2068 req = NULL;
2069
2070 ep_dbg(ep, "req:%p, udccsr 0x%03x loop=%d\n",
2071 req, udccsr, loop++);
2072
2073 if (unlikely(udccsr & (UDCCSR_SST | UDCCSR_TRN)))
2074 udc_ep_writel(ep, UDCCSR,
2075 udccsr & (UDCCSR_SST | UDCCSR_TRN));
2076 if (!req)
2077 break;
2078
2079 if (unlikely(is_in)) {
2080 if (likely(!ep_is_full(ep)))
2081 completed = write_fifo(ep, req);
2082 if (completed)
2083 ep_end_in_req(ep, req);
2084 } else {
2085 if (likely(epout_has_pkt(ep)))
2086 completed = read_fifo(ep, req);
2087 if (completed)
2088 ep_end_out_req(ep, req);
2089 }
2090 } while (completed);
2091}
2092
2093/**
2094 * pxa27x_change_configuration - Handle SET_CONF usb request notification
2095 * @udc: udc device
2096 * @config: usb configuration
2097 *
2098 * Post the request to upper level.
2099 * Don't use any pxa specific harware configuration capabilities
2100 */
2101static void pxa27x_change_configuration(struct pxa_udc *udc, int config)
2102{
2103 struct usb_ctrlrequest req ;
2104
2105 dev_dbg(udc->dev, "config=%d\n", config);
2106
2107 udc->config = config;
2108 udc->last_interface = 0;
2109 udc->last_alternate = 0;
2110
2111 req.bRequestType = 0;
2112 req.bRequest = USB_REQ_SET_CONFIGURATION;
2113 req.wValue = config;
2114 req.wIndex = 0;
2115 req.wLength = 0;
2116
2117 set_ep0state(udc, WAIT_ACK_SET_CONF_INTERF);
2118 udc->driver->setup(&udc->gadget, &req);
2119}
2120
2121/**
2122 * pxa27x_change_interface - Handle SET_INTERF usb request notification
2123 * @udc: udc device
2124 * @iface: interface number
2125 * @alt: alternate setting number
2126 *
2127 * Post the request to upper level.
2128 * Don't use any pxa specific harware configuration capabilities
2129 */
2130static void pxa27x_change_interface(struct pxa_udc *udc, int iface, int alt)
2131{
2132 struct usb_ctrlrequest req;
2133
2134 dev_dbg(udc->dev, "interface=%d, alternate setting=%d\n", iface, alt);
2135
2136 udc->last_interface = iface;
2137 udc->last_alternate = alt;
2138
2139 req.bRequestType = USB_RECIP_INTERFACE;
2140 req.bRequest = USB_REQ_SET_INTERFACE;
2141 req.wValue = alt;
2142 req.wIndex = iface;
2143 req.wLength = 0;
2144
2145 set_ep0state(udc, WAIT_ACK_SET_CONF_INTERF);
2146 udc->driver->setup(&udc->gadget, &req);
2147}
2148
2149/*
2150 * irq_handle_data - Handle data transfer
2151 * @irq: irq IRQ number
2152 * @udc: dev pxa_udc device structure
2153 *
2154 * Called from irq handler, transferts data to or from endpoint to queue
2155 */
2156static void irq_handle_data(int irq, struct pxa_udc *udc)
2157{
2158 int i;
2159 struct pxa_ep *ep;
2160 u32 udcisr0 = udc_readl(udc, UDCISR0) & UDCCISR0_EP_MASK;
2161 u32 udcisr1 = udc_readl(udc, UDCISR1) & UDCCISR1_EP_MASK;
2162
2163 if (udcisr0 & UDCISR_INT_MASK) {
2164 udc->pxa_ep[0].stats.irqs++;
2165 udc_writel(udc, UDCISR0, UDCISR_INT(0, UDCISR_INT_MASK));
2166 handle_ep0(udc, !!(udcisr0 & UDCICR_FIFOERR),
2167 !!(udcisr0 & UDCICR_PKTCOMPL));
2168 }
2169
2170 udcisr0 >>= 2;
2171 for (i = 1; udcisr0 != 0 && i < 16; udcisr0 >>= 2, i++) {
2172 if (!(udcisr0 & UDCISR_INT_MASK))
2173 continue;
2174
2175 udc_writel(udc, UDCISR0, UDCISR_INT(i, UDCISR_INT_MASK));
2176 ep = &udc->pxa_ep[i];
2177 ep->stats.irqs++;
2178 handle_ep(ep);
2179 }
2180
2181 for (i = 16; udcisr1 != 0 && i < 24; udcisr1 >>= 2, i++) {
2182 udc_writel(udc, UDCISR1, UDCISR_INT(i - 16, UDCISR_INT_MASK));
2183 if (!(udcisr1 & UDCISR_INT_MASK))
2184 continue;
2185
2186 ep = &udc->pxa_ep[i];
2187 ep->stats.irqs++;
2188 handle_ep(ep);
2189 }
2190
2191}
2192
2193/**
2194 * irq_udc_suspend - Handle IRQ "UDC Suspend"
2195 * @udc: udc device
2196 */
2197static void irq_udc_suspend(struct pxa_udc *udc)
2198{
2199 udc_writel(udc, UDCISR1, UDCISR1_IRSU);
2200 udc->stats.irqs_suspend++;
2201
2202 if (udc->gadget.speed != USB_SPEED_UNKNOWN
2203 && udc->driver && udc->driver->suspend)
2204 udc->driver->suspend(&udc->gadget);
2205 ep0_idle(udc);
2206}
2207
2208/**
2209 * irq_udc_resume - Handle IRQ "UDC Resume"
2210 * @udc: udc device
2211 */
2212static void irq_udc_resume(struct pxa_udc *udc)
2213{
2214 udc_writel(udc, UDCISR1, UDCISR1_IRRU);
2215 udc->stats.irqs_resume++;
2216
2217 if (udc->gadget.speed != USB_SPEED_UNKNOWN
2218 && udc->driver && udc->driver->resume)
2219 udc->driver->resume(&udc->gadget);
2220}
2221
2222/**
2223 * irq_udc_reconfig - Handle IRQ "UDC Change Configuration"
2224 * @udc: udc device
2225 */
2226static void irq_udc_reconfig(struct pxa_udc *udc)
2227{
2228 unsigned config, interface, alternate, config_change;
2229 u32 udccr = udc_readl(udc, UDCCR);
2230
2231 udc_writel(udc, UDCISR1, UDCISR1_IRCC);
2232 udc->stats.irqs_reconfig++;
2233
2234 config = (udccr & UDCCR_ACN) >> UDCCR_ACN_S;
2235 config_change = (config != udc->config);
2236 pxa27x_change_configuration(udc, config);
2237
2238 interface = (udccr & UDCCR_AIN) >> UDCCR_AIN_S;
2239 alternate = (udccr & UDCCR_AAISN) >> UDCCR_AAISN_S;
2240 pxa27x_change_interface(udc, interface, alternate);
2241
2242 if (config_change)
2243 update_pxa_ep_matches(udc);
2244 udc_set_mask_UDCCR(udc, UDCCR_SMAC);
2245}
2246
2247/**
2248 * irq_udc_reset - Handle IRQ "UDC Reset"
2249 * @udc: udc device
2250 */
2251static void irq_udc_reset(struct pxa_udc *udc)
2252{
2253 u32 udccr = udc_readl(udc, UDCCR);
2254 struct pxa_ep *ep = &udc->pxa_ep[0];
2255
2256 dev_info(udc->dev, "USB reset\n");
2257 udc_writel(udc, UDCISR1, UDCISR1_IRRS);
2258 udc->stats.irqs_reset++;
2259
2260 if ((udccr & UDCCR_UDA) == 0) {
2261 dev_dbg(udc->dev, "USB reset start\n");
2262 stop_activity(udc, udc->driver);
2263 }
2264 udc->gadget.speed = USB_SPEED_FULL;
2265 memset(&udc->stats, 0, sizeof udc->stats);
2266
2267 nuke(ep, -EPROTO);
2268 udc_ep_writel(ep, UDCCSR, UDCCSR0_FTF | UDCCSR0_OPC);
2269 ep0_idle(udc);
2270}
2271
2272/**
2273 * pxa_udc_irq - Main irq handler
2274 * @irq: irq number
2275 * @_dev: udc device
2276 *
2277 * Handles all udc interrupts
2278 */
2279static irqreturn_t pxa_udc_irq(int irq, void *_dev)
2280{
2281 struct pxa_udc *udc = _dev;
2282 u32 udcisr0 = udc_readl(udc, UDCISR0);
2283 u32 udcisr1 = udc_readl(udc, UDCISR1);
2284 u32 udccr = udc_readl(udc, UDCCR);
2285 u32 udcisr1_spec;
2286
2287 dev_vdbg(udc->dev, "Interrupt, UDCISR0:0x%08x, UDCISR1:0x%08x, "
2288 "UDCCR:0x%08x\n", udcisr0, udcisr1, udccr);
2289
2290 udcisr1_spec = udcisr1 & 0xf8000000;
2291 if (unlikely(udcisr1_spec & UDCISR1_IRSU))
2292 irq_udc_suspend(udc);
2293 if (unlikely(udcisr1_spec & UDCISR1_IRRU))
2294 irq_udc_resume(udc);
2295 if (unlikely(udcisr1_spec & UDCISR1_IRCC))
2296 irq_udc_reconfig(udc);
2297 if (unlikely(udcisr1_spec & UDCISR1_IRRS))
2298 irq_udc_reset(udc);
2299
2300 if ((udcisr0 & UDCCISR0_EP_MASK) | (udcisr1 & UDCCISR1_EP_MASK))
2301 irq_handle_data(irq, udc);
2302
2303 return IRQ_HANDLED;
2304}
2305
2306static struct pxa_udc memory = {
2307 .gadget = {
2308 .ops = &pxa_udc_ops,
2309 .ep0 = &memory.udc_usb_ep[0].usb_ep,
2310 .name = driver_name,
2311 .dev = {
c682b170 2312 .init_name = "gadget",
d75379a5
RJ
2313 },
2314 },
2315
2316 .udc_usb_ep = {
2317 USB_EP_CTRL,
2318 USB_EP_OUT_BULK(1),
2319 USB_EP_IN_BULK(2),
2320 USB_EP_IN_ISO(3),
2321 USB_EP_OUT_ISO(4),
2322 USB_EP_IN_INT(5),
2323 },
2324
2325 .pxa_ep = {
2326 PXA_EP_CTRL,
2327 /* Endpoints for gadget zero */
2328 PXA_EP_OUT_BULK(1, 1, 3, 0, 0),
2329 PXA_EP_IN_BULK(2, 2, 3, 0, 0),
2330 /* Endpoints for ether gadget, file storage gadget */
2331 PXA_EP_OUT_BULK(3, 1, 1, 0, 0),
2332 PXA_EP_IN_BULK(4, 2, 1, 0, 0),
2333 PXA_EP_IN_ISO(5, 3, 1, 0, 0),
2334 PXA_EP_OUT_ISO(6, 4, 1, 0, 0),
2335 PXA_EP_IN_INT(7, 5, 1, 0, 0),
2336 /* Endpoints for RNDIS, serial */
2337 PXA_EP_OUT_BULK(8, 1, 2, 0, 0),
2338 PXA_EP_IN_BULK(9, 2, 2, 0, 0),
2339 PXA_EP_IN_INT(10, 5, 2, 0, 0),
2340 /*
2341 * All the following endpoints are only for completion. They
2342 * won't never work, as multiple interfaces are really broken on
2343 * the pxa.
2344 */
2345 PXA_EP_OUT_BULK(11, 1, 2, 1, 0),
2346 PXA_EP_IN_BULK(12, 2, 2, 1, 0),
2347 /* Endpoint for CDC Ether */
2348 PXA_EP_OUT_BULK(13, 1, 1, 1, 1),
2349 PXA_EP_IN_BULK(14, 2, 1, 1, 1),
2350 }
2351};
2352
2353/**
2354 * pxa_udc_probe - probes the udc device
2355 * @_dev: platform device
2356 *
2357 * Perform basic init : allocates udc clock, creates sysfs files, requests
2358 * irq.
2359 */
2360static int __init pxa_udc_probe(struct platform_device *pdev)
2361{
2362 struct resource *regs;
2363 struct pxa_udc *udc = &memory;
eb507025 2364 int retval = 0, gpio;
d75379a5
RJ
2365
2366 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2367 if (!regs)
2368 return -ENXIO;
2369 udc->irq = platform_get_irq(pdev, 0);
2370 if (udc->irq < 0)
2371 return udc->irq;
2372
2373 udc->dev = &pdev->dev;
2374 udc->mach = pdev->dev.platform_data;
7fec3c25 2375 udc->transceiver = otg_get_transceiver();
d75379a5 2376
eb507025
RJ
2377 gpio = udc->mach->gpio_pullup;
2378 if (gpio_is_valid(gpio)) {
2379 retval = gpio_request(gpio, "USB D+ pullup");
2380 if (retval == 0)
2381 gpio_direction_output(gpio,
2382 udc->mach->gpio_pullup_inverted);
2383 }
2384 if (retval) {
2385 dev_err(&pdev->dev, "Couldn't request gpio %d : %d\n",
2386 gpio, retval);
2387 return retval;
2388 }
2389
e0d8b13a 2390 udc->clk = clk_get(&pdev->dev, NULL);
d75379a5
RJ
2391 if (IS_ERR(udc->clk)) {
2392 retval = PTR_ERR(udc->clk);
2393 goto err_clk;
2394 }
2395
2396 retval = -ENOMEM;
2397 udc->regs = ioremap(regs->start, regs->end - regs->start + 1);
2398 if (!udc->regs) {
2399 dev_err(&pdev->dev, "Unable to map UDC I/O memory\n");
2400 goto err_map;
2401 }
2402
2403 device_initialize(&udc->gadget.dev);
2404 udc->gadget.dev.parent = &pdev->dev;
2405 udc->gadget.dev.dma_mask = NULL;
b799a7eb 2406 udc->vbus_sensed = 0;
d75379a5
RJ
2407
2408 the_controller = udc;
2409 platform_set_drvdata(pdev, udc);
2410 udc_init_data(udc);
2411 pxa_eps_setup(udc);
2412
2413 /* irq setup after old hardware state is cleaned up */
2414 retval = request_irq(udc->irq, pxa_udc_irq,
2415 IRQF_SHARED, driver_name, udc);
2416 if (retval != 0) {
2417 dev_err(udc->dev, "%s: can't get irq %i, err %d\n",
2418 driver_name, IRQ_USB, retval);
2419 goto err_irq;
2420 }
2421
2422 pxa_init_debugfs(udc);
2423 return 0;
2424err_irq:
2425 iounmap(udc->regs);
2426err_map:
2427 clk_put(udc->clk);
2428 udc->clk = NULL;
2429err_clk:
2430 return retval;
2431}
2432
2433/**
2434 * pxa_udc_remove - removes the udc device driver
2435 * @_dev: platform device
2436 */
2437static int __exit pxa_udc_remove(struct platform_device *_dev)
2438{
2439 struct pxa_udc *udc = platform_get_drvdata(_dev);
eb507025 2440 int gpio = udc->mach->gpio_pullup;
d75379a5
RJ
2441
2442 usb_gadget_unregister_driver(udc->driver);
2443 free_irq(udc->irq, udc);
2444 pxa_cleanup_debugfs(udc);
eb507025
RJ
2445 if (gpio_is_valid(gpio))
2446 gpio_free(gpio);
d75379a5 2447
7fec3c25
RJ
2448 otg_put_transceiver(udc->transceiver);
2449
2450 udc->transceiver = NULL;
d75379a5
RJ
2451 platform_set_drvdata(_dev, NULL);
2452 the_controller = NULL;
2453 clk_put(udc->clk);
2454
2455 return 0;
2456}
2457
2458static void pxa_udc_shutdown(struct platform_device *_dev)
2459{
2460 struct pxa_udc *udc = platform_get_drvdata(_dev);
2461
5a59bc54
RJ
2462 if (udc_readl(udc, UDCCR) & UDCCR_UDE)
2463 udc_disable(udc);
d75379a5
RJ
2464}
2465
2466#ifdef CONFIG_PM
2467/**
2468 * pxa_udc_suspend - Suspend udc device
2469 * @_dev: platform device
2470 * @state: suspend state
2471 *
2472 * Suspends udc : saves configuration registers (UDCCR*), then disables the udc
2473 * device.
2474 */
2475static int pxa_udc_suspend(struct platform_device *_dev, pm_message_t state)
2476{
2477 int i;
2478 struct pxa_udc *udc = platform_get_drvdata(_dev);
2479 struct pxa_ep *ep;
2480
2481 ep = &udc->pxa_ep[0];
2482 udc->udccsr0 = udc_ep_readl(ep, UDCCSR);
2483 for (i = 1; i < NR_PXA_ENDPOINTS; i++) {
2484 ep = &udc->pxa_ep[i];
2485 ep->udccsr_value = udc_ep_readl(ep, UDCCSR);
2486 ep->udccr_value = udc_ep_readl(ep, UDCCR);
2487 ep_dbg(ep, "udccsr:0x%03x, udccr:0x%x\n",
2488 ep->udccsr_value, ep->udccr_value);
2489 }
2490
2491 udc_disable(udc);
eb507025
RJ
2492 udc->pullup_resume = udc->pullup_on;
2493 dplus_pullup(udc, 0);
d75379a5
RJ
2494
2495 return 0;
2496}
2497
2498/**
2499 * pxa_udc_resume - Resume udc device
2500 * @_dev: platform device
2501 *
2502 * Resumes udc : restores configuration registers (UDCCR*), then enables the udc
2503 * device.
2504 */
2505static int pxa_udc_resume(struct platform_device *_dev)
2506{
2507 int i;
2508 struct pxa_udc *udc = platform_get_drvdata(_dev);
2509 struct pxa_ep *ep;
2510
2511 ep = &udc->pxa_ep[0];
2512 udc_ep_writel(ep, UDCCSR, udc->udccsr0 & (UDCCSR0_FST | UDCCSR0_DME));
2513 for (i = 1; i < NR_PXA_ENDPOINTS; i++) {
2514 ep = &udc->pxa_ep[i];
2515 udc_ep_writel(ep, UDCCSR, ep->udccsr_value);
2516 udc_ep_writel(ep, UDCCR, ep->udccr_value);
2517 ep_dbg(ep, "udccsr:0x%03x, udccr:0x%x\n",
2518 ep->udccsr_value, ep->udccr_value);
2519 }
2520
eb507025
RJ
2521 dplus_pullup(udc, udc->pullup_resume);
2522 if (should_enable_udc(udc))
2523 udc_enable(udc);
d75379a5
RJ
2524 /*
2525 * We do not handle OTG yet.
2526 *
2527 * OTGPH bit is set when sleep mode is entered.
2528 * it indicates that OTG pad is retaining its state.
2529 * Upon exit from sleep mode and before clearing OTGPH,
2530 * Software must configure the USB OTG pad, UDC, and UHC
2531 * to the state they were in before entering sleep mode.
d75379a5 2532 */
d438ae57
PZ
2533 if (cpu_is_pxa27x())
2534 PSSR |= PSSR_OTGPH;
d75379a5
RJ
2535
2536 return 0;
2537}
2538#endif
2539
2540/* work with hotplug and coldplug */
7a857620 2541MODULE_ALIAS("platform:pxa27x-udc");
d75379a5
RJ
2542
2543static struct platform_driver udc_driver = {
2544 .driver = {
7a857620 2545 .name = "pxa27x-udc",
d75379a5
RJ
2546 .owner = THIS_MODULE,
2547 },
2548 .remove = __exit_p(pxa_udc_remove),
2549 .shutdown = pxa_udc_shutdown,
2550#ifdef CONFIG_PM
2551 .suspend = pxa_udc_suspend,
2552 .resume = pxa_udc_resume
2553#endif
2554};
2555
2556static int __init udc_init(void)
2557{
5a59bc54
RJ
2558 if (!cpu_is_pxa27x())
2559 return -ENODEV;
2560
d75379a5
RJ
2561 printk(KERN_INFO "%s: version %s\n", driver_name, DRIVER_VERSION);
2562 return platform_driver_probe(&udc_driver, pxa_udc_probe);
2563}
2564module_init(udc_init);
2565
2566
2567static void __exit udc_exit(void)
2568{
2569 platform_driver_unregister(&udc_driver);
2570}
2571module_exit(udc_exit);
2572
2573MODULE_DESCRIPTION(DRIVER_DESC);
2574MODULE_AUTHOR("Robert Jarzmik");
2575MODULE_LICENSE("GPL");