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