Merge remote-tracking branch 'usb-chipidea-next/ci-for-usb-next'
[deliverable/linux.git] / drivers / usb / chipidea / udc.c
1 /*
2 * udc.c - ChipIdea UDC driver
3 *
4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
5 *
6 * Author: David Lopo
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13 #include <linux/delay.h>
14 #include <linux/device.h>
15 #include <linux/dmapool.h>
16 #include <linux/err.h>
17 #include <linux/irqreturn.h>
18 #include <linux/kernel.h>
19 #include <linux/slab.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/usb/ch9.h>
22 #include <linux/usb/gadget.h>
23 #include <linux/usb/otg-fsm.h>
24 #include <linux/usb/chipidea.h>
25
26 #include "ci.h"
27 #include "udc.h"
28 #include "bits.h"
29 #include "otg.h"
30 #include "otg_fsm.h"
31
32 /* control endpoint description */
33 static const struct usb_endpoint_descriptor
34 ctrl_endpt_out_desc = {
35 .bLength = USB_DT_ENDPOINT_SIZE,
36 .bDescriptorType = USB_DT_ENDPOINT,
37
38 .bEndpointAddress = USB_DIR_OUT,
39 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
40 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
41 };
42
43 static const struct usb_endpoint_descriptor
44 ctrl_endpt_in_desc = {
45 .bLength = USB_DT_ENDPOINT_SIZE,
46 .bDescriptorType = USB_DT_ENDPOINT,
47
48 .bEndpointAddress = USB_DIR_IN,
49 .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
50 .wMaxPacketSize = cpu_to_le16(CTRL_PAYLOAD_MAX),
51 };
52
53 /**
54 * hw_ep_bit: calculates the bit number
55 * @num: endpoint number
56 * @dir: endpoint direction
57 *
58 * This function returns bit number
59 */
60 static inline int hw_ep_bit(int num, int dir)
61 {
62 return num + ((dir == TX) ? 16 : 0);
63 }
64
65 static inline int ep_to_bit(struct ci_hdrc *ci, int n)
66 {
67 int fill = 16 - ci->hw_ep_max / 2;
68
69 if (n >= ci->hw_ep_max / 2)
70 n += fill;
71
72 return n;
73 }
74
75 /**
76 * hw_device_state: enables/disables interrupts (execute without interruption)
77 * @dma: 0 => disable, !0 => enable and set dma engine
78 *
79 * This function returns an error code
80 */
81 static int hw_device_state(struct ci_hdrc *ci, u32 dma)
82 {
83 if (dma) {
84 hw_write(ci, OP_ENDPTLISTADDR, ~0, dma);
85 /* interrupt, error, port change, reset, sleep/suspend */
86 hw_write(ci, OP_USBINTR, ~0,
87 USBi_UI|USBi_UEI|USBi_PCI|USBi_URI|USBi_SLI);
88 } else {
89 hw_write(ci, OP_USBINTR, ~0, 0);
90 }
91 return 0;
92 }
93
94 /**
95 * hw_ep_flush: flush endpoint fifo (execute without interruption)
96 * @num: endpoint number
97 * @dir: endpoint direction
98 *
99 * This function returns an error code
100 */
101 static int hw_ep_flush(struct ci_hdrc *ci, int num, int dir)
102 {
103 int n = hw_ep_bit(num, dir);
104
105 do {
106 /* flush any pending transfer */
107 hw_write(ci, OP_ENDPTFLUSH, ~0, BIT(n));
108 while (hw_read(ci, OP_ENDPTFLUSH, BIT(n)))
109 cpu_relax();
110 } while (hw_read(ci, OP_ENDPTSTAT, BIT(n)));
111
112 return 0;
113 }
114
115 /**
116 * hw_ep_disable: disables endpoint (execute without interruption)
117 * @num: endpoint number
118 * @dir: endpoint direction
119 *
120 * This function returns an error code
121 */
122 static int hw_ep_disable(struct ci_hdrc *ci, int num, int dir)
123 {
124 hw_write(ci, OP_ENDPTCTRL + num,
125 (dir == TX) ? ENDPTCTRL_TXE : ENDPTCTRL_RXE, 0);
126 return 0;
127 }
128
129 /**
130 * hw_ep_enable: enables endpoint (execute without interruption)
131 * @num: endpoint number
132 * @dir: endpoint direction
133 * @type: endpoint type
134 *
135 * This function returns an error code
136 */
137 static int hw_ep_enable(struct ci_hdrc *ci, int num, int dir, int type)
138 {
139 u32 mask, data;
140
141 if (dir == TX) {
142 mask = ENDPTCTRL_TXT; /* type */
143 data = type << __ffs(mask);
144
145 mask |= ENDPTCTRL_TXS; /* unstall */
146 mask |= ENDPTCTRL_TXR; /* reset data toggle */
147 data |= ENDPTCTRL_TXR;
148 mask |= ENDPTCTRL_TXE; /* enable */
149 data |= ENDPTCTRL_TXE;
150 } else {
151 mask = ENDPTCTRL_RXT; /* type */
152 data = type << __ffs(mask);
153
154 mask |= ENDPTCTRL_RXS; /* unstall */
155 mask |= ENDPTCTRL_RXR; /* reset data toggle */
156 data |= ENDPTCTRL_RXR;
157 mask |= ENDPTCTRL_RXE; /* enable */
158 data |= ENDPTCTRL_RXE;
159 }
160 hw_write(ci, OP_ENDPTCTRL + num, mask, data);
161 return 0;
162 }
163
164 /**
165 * hw_ep_get_halt: return endpoint halt status
166 * @num: endpoint number
167 * @dir: endpoint direction
168 *
169 * This function returns 1 if endpoint halted
170 */
171 static int hw_ep_get_halt(struct ci_hdrc *ci, int num, int dir)
172 {
173 u32 mask = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
174
175 return hw_read(ci, OP_ENDPTCTRL + num, mask) ? 1 : 0;
176 }
177
178 /**
179 * hw_ep_prime: primes endpoint (execute without interruption)
180 * @num: endpoint number
181 * @dir: endpoint direction
182 * @is_ctrl: true if control endpoint
183 *
184 * This function returns an error code
185 */
186 static int hw_ep_prime(struct ci_hdrc *ci, int num, int dir, int is_ctrl)
187 {
188 int n = hw_ep_bit(num, dir);
189
190 /* Synchronize before ep prime */
191 wmb();
192
193 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
194 return -EAGAIN;
195
196 hw_write(ci, OP_ENDPTPRIME, ~0, BIT(n));
197
198 while (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
199 cpu_relax();
200 if (is_ctrl && dir == RX && hw_read(ci, OP_ENDPTSETUPSTAT, BIT(num)))
201 return -EAGAIN;
202
203 /* status shoult be tested according with manual but it doesn't work */
204 return 0;
205 }
206
207 /**
208 * hw_ep_set_halt: configures ep halt & resets data toggle after clear (execute
209 * without interruption)
210 * @num: endpoint number
211 * @dir: endpoint direction
212 * @value: true => stall, false => unstall
213 *
214 * This function returns an error code
215 */
216 static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value)
217 {
218 if (value != 0 && value != 1)
219 return -EINVAL;
220
221 do {
222 enum ci_hw_regs reg = OP_ENDPTCTRL + num;
223 u32 mask_xs = (dir == TX) ? ENDPTCTRL_TXS : ENDPTCTRL_RXS;
224 u32 mask_xr = (dir == TX) ? ENDPTCTRL_TXR : ENDPTCTRL_RXR;
225
226 /* data toggle - reserved for EP0 but it's in ESS */
227 hw_write(ci, reg, mask_xs|mask_xr,
228 value ? mask_xs : mask_xr);
229 } while (value != hw_ep_get_halt(ci, num, dir));
230
231 return 0;
232 }
233
234 /**
235 * hw_is_port_high_speed: test if port is high speed
236 *
237 * This function returns true if high speed port
238 */
239 static int hw_port_is_high_speed(struct ci_hdrc *ci)
240 {
241 return ci->hw_bank.lpm ? hw_read(ci, OP_DEVLC, DEVLC_PSPD) :
242 hw_read(ci, OP_PORTSC, PORTSC_HSP);
243 }
244
245 /**
246 * hw_test_and_clear_complete: test & clear complete status (execute without
247 * interruption)
248 * @n: endpoint number
249 *
250 * This function returns complete status
251 */
252 static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n)
253 {
254 n = ep_to_bit(ci, n);
255 return hw_test_and_clear(ci, OP_ENDPTCOMPLETE, BIT(n));
256 }
257
258 /**
259 * hw_test_and_clear_intr_active: test & clear active interrupts (execute
260 * without interruption)
261 *
262 * This function returns active interrutps
263 */
264 static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci)
265 {
266 u32 reg = hw_read_intr_status(ci) & hw_read_intr_enable(ci);
267
268 hw_write(ci, OP_USBSTS, ~0, reg);
269 return reg;
270 }
271
272 /**
273 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without
274 * interruption)
275 *
276 * This function returns guard value
277 */
278 static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci)
279 {
280 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, 0);
281 }
282
283 /**
284 * hw_test_and_set_setup_guard: test & set setup guard (execute without
285 * interruption)
286 *
287 * This function returns guard value
288 */
289 static int hw_test_and_set_setup_guard(struct ci_hdrc *ci)
290 {
291 return hw_test_and_write(ci, OP_USBCMD, USBCMD_SUTW, USBCMD_SUTW);
292 }
293
294 /**
295 * hw_usb_set_address: configures USB address (execute without interruption)
296 * @value: new USB address
297 *
298 * This function explicitly sets the address, without the "USBADRA" (advance)
299 * feature, which is not supported by older versions of the controller.
300 */
301 static void hw_usb_set_address(struct ci_hdrc *ci, u8 value)
302 {
303 hw_write(ci, OP_DEVICEADDR, DEVICEADDR_USBADR,
304 value << __ffs(DEVICEADDR_USBADR));
305 }
306
307 /**
308 * hw_usb_reset: restart device after a bus reset (execute without
309 * interruption)
310 *
311 * This function returns an error code
312 */
313 static int hw_usb_reset(struct ci_hdrc *ci)
314 {
315 hw_usb_set_address(ci, 0);
316
317 /* ESS flushes only at end?!? */
318 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
319
320 /* clear setup token semaphores */
321 hw_write(ci, OP_ENDPTSETUPSTAT, 0, 0);
322
323 /* clear complete status */
324 hw_write(ci, OP_ENDPTCOMPLETE, 0, 0);
325
326 /* wait until all bits cleared */
327 while (hw_read(ci, OP_ENDPTPRIME, ~0))
328 udelay(10); /* not RTOS friendly */
329
330 /* reset all endpoints ? */
331
332 /* reset internal status and wait for further instructions
333 no need to verify the port reset status (ESS does it) */
334
335 return 0;
336 }
337
338 /******************************************************************************
339 * UTIL block
340 *****************************************************************************/
341
342 static int add_td_to_list(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq,
343 unsigned length)
344 {
345 int i;
346 u32 temp;
347 struct td_node *lastnode, *node = kzalloc(sizeof(struct td_node),
348 GFP_ATOMIC);
349
350 if (node == NULL)
351 return -ENOMEM;
352
353 node->ptr = dma_pool_zalloc(hwep->td_pool, GFP_ATOMIC,
354 &node->dma);
355 if (node->ptr == NULL) {
356 kfree(node);
357 return -ENOMEM;
358 }
359
360 node->ptr->token = cpu_to_le32(length << __ffs(TD_TOTAL_BYTES));
361 node->ptr->token &= cpu_to_le32(TD_TOTAL_BYTES);
362 node->ptr->token |= cpu_to_le32(TD_STATUS_ACTIVE);
363 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX) {
364 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
365
366 if (hwreq->req.length == 0
367 || hwreq->req.length % hwep->ep.maxpacket)
368 mul++;
369 node->ptr->token |= mul << __ffs(TD_MULTO);
370 }
371
372 temp = (u32) (hwreq->req.dma + hwreq->req.actual);
373 if (length) {
374 node->ptr->page[0] = cpu_to_le32(temp);
375 for (i = 1; i < TD_PAGE_COUNT; i++) {
376 u32 page = temp + i * CI_HDRC_PAGE_SIZE;
377 page &= ~TD_RESERVED_MASK;
378 node->ptr->page[i] = cpu_to_le32(page);
379 }
380 }
381
382 hwreq->req.actual += length;
383
384 if (!list_empty(&hwreq->tds)) {
385 /* get the last entry */
386 lastnode = list_entry(hwreq->tds.prev,
387 struct td_node, td);
388 lastnode->ptr->next = cpu_to_le32(node->dma);
389 }
390
391 INIT_LIST_HEAD(&node->td);
392 list_add_tail(&node->td, &hwreq->tds);
393
394 return 0;
395 }
396
397 /**
398 * _usb_addr: calculates endpoint address from direction & number
399 * @ep: endpoint
400 */
401 static inline u8 _usb_addr(struct ci_hw_ep *ep)
402 {
403 return ((ep->dir == TX) ? USB_ENDPOINT_DIR_MASK : 0) | ep->num;
404 }
405
406 /**
407 * _hardware_enqueue: configures a request at hardware level
408 * @hwep: endpoint
409 * @hwreq: request
410 *
411 * This function returns an error code
412 */
413 static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
414 {
415 struct ci_hdrc *ci = hwep->ci;
416 int ret = 0;
417 unsigned rest = hwreq->req.length;
418 int pages = TD_PAGE_COUNT;
419 struct td_node *firstnode, *lastnode;
420
421 /* don't queue twice */
422 if (hwreq->req.status == -EALREADY)
423 return -EALREADY;
424
425 hwreq->req.status = -EALREADY;
426
427 ret = usb_gadget_map_request(&ci->gadget, &hwreq->req, hwep->dir);
428 if (ret)
429 return ret;
430
431 /*
432 * The first buffer could be not page aligned.
433 * In that case we have to span into one extra td.
434 */
435 if (hwreq->req.dma % PAGE_SIZE)
436 pages--;
437
438 if (rest == 0) {
439 ret = add_td_to_list(hwep, hwreq, 0);
440 if (ret < 0)
441 goto done;
442 }
443
444 while (rest > 0) {
445 unsigned count = min(hwreq->req.length - hwreq->req.actual,
446 (unsigned)(pages * CI_HDRC_PAGE_SIZE));
447 ret = add_td_to_list(hwep, hwreq, count);
448 if (ret < 0)
449 goto done;
450
451 rest -= count;
452 }
453
454 if (hwreq->req.zero && hwreq->req.length && hwep->dir == TX
455 && (hwreq->req.length % hwep->ep.maxpacket == 0)) {
456 ret = add_td_to_list(hwep, hwreq, 0);
457 if (ret < 0)
458 goto done;
459 }
460
461 firstnode = list_first_entry(&hwreq->tds, struct td_node, td);
462
463 lastnode = list_entry(hwreq->tds.prev,
464 struct td_node, td);
465
466 lastnode->ptr->next = cpu_to_le32(TD_TERMINATE);
467 if (!hwreq->req.no_interrupt)
468 lastnode->ptr->token |= cpu_to_le32(TD_IOC);
469 wmb();
470
471 hwreq->req.actual = 0;
472 if (!list_empty(&hwep->qh.queue)) {
473 struct ci_hw_req *hwreqprev;
474 int n = hw_ep_bit(hwep->num, hwep->dir);
475 int tmp_stat;
476 struct td_node *prevlastnode;
477 u32 next = firstnode->dma & TD_ADDR_MASK;
478
479 hwreqprev = list_entry(hwep->qh.queue.prev,
480 struct ci_hw_req, queue);
481 prevlastnode = list_entry(hwreqprev->tds.prev,
482 struct td_node, td);
483
484 prevlastnode->ptr->next = cpu_to_le32(next);
485 wmb();
486 if (hw_read(ci, OP_ENDPTPRIME, BIT(n)))
487 goto done;
488 do {
489 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, USBCMD_ATDTW);
490 tmp_stat = hw_read(ci, OP_ENDPTSTAT, BIT(n));
491 } while (!hw_read(ci, OP_USBCMD, USBCMD_ATDTW));
492 hw_write(ci, OP_USBCMD, USBCMD_ATDTW, 0);
493 if (tmp_stat)
494 goto done;
495 }
496
497 /* QH configuration */
498 hwep->qh.ptr->td.next = cpu_to_le32(firstnode->dma);
499 hwep->qh.ptr->td.token &=
500 cpu_to_le32(~(TD_STATUS_HALTED|TD_STATUS_ACTIVE));
501
502 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == RX) {
503 u32 mul = hwreq->req.length / hwep->ep.maxpacket;
504
505 if (hwreq->req.length == 0
506 || hwreq->req.length % hwep->ep.maxpacket)
507 mul++;
508 hwep->qh.ptr->cap |= mul << __ffs(QH_MULT);
509 }
510
511 ret = hw_ep_prime(ci, hwep->num, hwep->dir,
512 hwep->type == USB_ENDPOINT_XFER_CONTROL);
513 done:
514 return ret;
515 }
516
517 /*
518 * free_pending_td: remove a pending request for the endpoint
519 * @hwep: endpoint
520 */
521 static void free_pending_td(struct ci_hw_ep *hwep)
522 {
523 struct td_node *pending = hwep->pending_td;
524
525 dma_pool_free(hwep->td_pool, pending->ptr, pending->dma);
526 hwep->pending_td = NULL;
527 kfree(pending);
528 }
529
530 static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep,
531 struct td_node *node)
532 {
533 hwep->qh.ptr->td.next = node->dma;
534 hwep->qh.ptr->td.token &=
535 cpu_to_le32(~(TD_STATUS_HALTED | TD_STATUS_ACTIVE));
536
537 return hw_ep_prime(ci, hwep->num, hwep->dir,
538 hwep->type == USB_ENDPOINT_XFER_CONTROL);
539 }
540
541 /**
542 * _hardware_dequeue: handles a request at hardware level
543 * @gadget: gadget
544 * @hwep: endpoint
545 *
546 * This function returns an error code
547 */
548 static int _hardware_dequeue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq)
549 {
550 u32 tmptoken;
551 struct td_node *node, *tmpnode;
552 unsigned remaining_length;
553 unsigned actual = hwreq->req.length;
554 struct ci_hdrc *ci = hwep->ci;
555
556 if (hwreq->req.status != -EALREADY)
557 return -EINVAL;
558
559 hwreq->req.status = 0;
560
561 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
562 tmptoken = le32_to_cpu(node->ptr->token);
563 if ((TD_STATUS_ACTIVE & tmptoken) != 0) {
564 int n = hw_ep_bit(hwep->num, hwep->dir);
565
566 if (ci->rev == CI_REVISION_24)
567 if (!hw_read(ci, OP_ENDPTSTAT, BIT(n)))
568 reprime_dtd(ci, hwep, node);
569 hwreq->req.status = -EALREADY;
570 return -EBUSY;
571 }
572
573 remaining_length = (tmptoken & TD_TOTAL_BYTES);
574 remaining_length >>= __ffs(TD_TOTAL_BYTES);
575 actual -= remaining_length;
576
577 hwreq->req.status = tmptoken & TD_STATUS;
578 if ((TD_STATUS_HALTED & hwreq->req.status)) {
579 hwreq->req.status = -EPIPE;
580 break;
581 } else if ((TD_STATUS_DT_ERR & hwreq->req.status)) {
582 hwreq->req.status = -EPROTO;
583 break;
584 } else if ((TD_STATUS_TR_ERR & hwreq->req.status)) {
585 hwreq->req.status = -EILSEQ;
586 break;
587 }
588
589 if (remaining_length) {
590 if (hwep->dir == TX) {
591 hwreq->req.status = -EPROTO;
592 break;
593 }
594 }
595 /*
596 * As the hardware could still address the freed td
597 * which will run the udc unusable, the cleanup of the
598 * td has to be delayed by one.
599 */
600 if (hwep->pending_td)
601 free_pending_td(hwep);
602
603 hwep->pending_td = node;
604 list_del_init(&node->td);
605 }
606
607 usb_gadget_unmap_request(&hwep->ci->gadget, &hwreq->req, hwep->dir);
608
609 hwreq->req.actual += actual;
610
611 if (hwreq->req.status)
612 return hwreq->req.status;
613
614 return hwreq->req.actual;
615 }
616
617 /**
618 * _ep_nuke: dequeues all endpoint requests
619 * @hwep: endpoint
620 *
621 * This function returns an error code
622 * Caller must hold lock
623 */
624 static int _ep_nuke(struct ci_hw_ep *hwep)
625 __releases(hwep->lock)
626 __acquires(hwep->lock)
627 {
628 struct td_node *node, *tmpnode;
629 if (hwep == NULL)
630 return -EINVAL;
631
632 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
633
634 while (!list_empty(&hwep->qh.queue)) {
635
636 /* pop oldest request */
637 struct ci_hw_req *hwreq = list_entry(hwep->qh.queue.next,
638 struct ci_hw_req, queue);
639
640 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
641 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
642 list_del_init(&node->td);
643 node->ptr = NULL;
644 kfree(node);
645 }
646
647 list_del_init(&hwreq->queue);
648 hwreq->req.status = -ESHUTDOWN;
649
650 if (hwreq->req.complete != NULL) {
651 spin_unlock(hwep->lock);
652 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
653 spin_lock(hwep->lock);
654 }
655 }
656
657 if (hwep->pending_td)
658 free_pending_td(hwep);
659
660 return 0;
661 }
662
663 static int _ep_set_halt(struct usb_ep *ep, int value, bool check_transfer)
664 {
665 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
666 int direction, retval = 0;
667 unsigned long flags;
668
669 if (ep == NULL || hwep->ep.desc == NULL)
670 return -EINVAL;
671
672 if (usb_endpoint_xfer_isoc(hwep->ep.desc))
673 return -EOPNOTSUPP;
674
675 spin_lock_irqsave(hwep->lock, flags);
676
677 if (value && hwep->dir == TX && check_transfer &&
678 !list_empty(&hwep->qh.queue) &&
679 !usb_endpoint_xfer_control(hwep->ep.desc)) {
680 spin_unlock_irqrestore(hwep->lock, flags);
681 return -EAGAIN;
682 }
683
684 direction = hwep->dir;
685 do {
686 retval |= hw_ep_set_halt(hwep->ci, hwep->num, hwep->dir, value);
687
688 if (!value)
689 hwep->wedge = 0;
690
691 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
692 hwep->dir = (hwep->dir == TX) ? RX : TX;
693
694 } while (hwep->dir != direction);
695
696 spin_unlock_irqrestore(hwep->lock, flags);
697 return retval;
698 }
699
700
701 /**
702 * _gadget_stop_activity: stops all USB activity, flushes & disables all endpts
703 * @gadget: gadget
704 *
705 * This function returns an error code
706 */
707 static int _gadget_stop_activity(struct usb_gadget *gadget)
708 {
709 struct usb_ep *ep;
710 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
711 unsigned long flags;
712
713 spin_lock_irqsave(&ci->lock, flags);
714 ci->gadget.speed = USB_SPEED_UNKNOWN;
715 ci->remote_wakeup = 0;
716 ci->suspended = 0;
717 spin_unlock_irqrestore(&ci->lock, flags);
718
719 /* flush all endpoints */
720 gadget_for_each_ep(ep, gadget) {
721 usb_ep_fifo_flush(ep);
722 }
723 usb_ep_fifo_flush(&ci->ep0out->ep);
724 usb_ep_fifo_flush(&ci->ep0in->ep);
725
726 /* make sure to disable all endpoints */
727 gadget_for_each_ep(ep, gadget) {
728 usb_ep_disable(ep);
729 }
730
731 if (ci->status != NULL) {
732 usb_ep_free_request(&ci->ep0in->ep, ci->status);
733 ci->status = NULL;
734 }
735
736 return 0;
737 }
738
739 /******************************************************************************
740 * ISR block
741 *****************************************************************************/
742 /**
743 * isr_reset_handler: USB reset interrupt handler
744 * @ci: UDC device
745 *
746 * This function resets USB engine after a bus reset occurred
747 */
748 static void isr_reset_handler(struct ci_hdrc *ci)
749 __releases(ci->lock)
750 __acquires(ci->lock)
751 {
752 int retval;
753
754 spin_unlock(&ci->lock);
755 if (ci->gadget.speed != USB_SPEED_UNKNOWN)
756 usb_gadget_udc_reset(&ci->gadget, ci->driver);
757
758 retval = _gadget_stop_activity(&ci->gadget);
759 if (retval)
760 goto done;
761
762 retval = hw_usb_reset(ci);
763 if (retval)
764 goto done;
765
766 ci->status = usb_ep_alloc_request(&ci->ep0in->ep, GFP_ATOMIC);
767 if (ci->status == NULL)
768 retval = -ENOMEM;
769
770 done:
771 spin_lock(&ci->lock);
772
773 if (retval)
774 dev_err(ci->dev, "error: %i\n", retval);
775 }
776
777 /**
778 * isr_get_status_complete: get_status request complete function
779 * @ep: endpoint
780 * @req: request handled
781 *
782 * Caller must release lock
783 */
784 static void isr_get_status_complete(struct usb_ep *ep, struct usb_request *req)
785 {
786 if (ep == NULL || req == NULL)
787 return;
788
789 kfree(req->buf);
790 usb_ep_free_request(ep, req);
791 }
792
793 /**
794 * _ep_queue: queues (submits) an I/O request to an endpoint
795 * @ep: endpoint
796 * @req: request
797 * @gfp_flags: GFP flags (not used)
798 *
799 * Caller must hold lock
800 * This function returns an error code
801 */
802 static int _ep_queue(struct usb_ep *ep, struct usb_request *req,
803 gfp_t __maybe_unused gfp_flags)
804 {
805 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
806 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
807 struct ci_hdrc *ci = hwep->ci;
808 int retval = 0;
809
810 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
811 return -EINVAL;
812
813 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
814 if (req->length)
815 hwep = (ci->ep0_dir == RX) ?
816 ci->ep0out : ci->ep0in;
817 if (!list_empty(&hwep->qh.queue)) {
818 _ep_nuke(hwep);
819 dev_warn(hwep->ci->dev, "endpoint ctrl %X nuked\n",
820 _usb_addr(hwep));
821 }
822 }
823
824 if (usb_endpoint_xfer_isoc(hwep->ep.desc) &&
825 hwreq->req.length > (1 + hwep->ep.mult) * hwep->ep.maxpacket) {
826 dev_err(hwep->ci->dev, "request length too big for isochronous\n");
827 return -EMSGSIZE;
828 }
829
830 /* first nuke then test link, e.g. previous status has not sent */
831 if (!list_empty(&hwreq->queue)) {
832 dev_err(hwep->ci->dev, "request already in queue\n");
833 return -EBUSY;
834 }
835
836 /* push request */
837 hwreq->req.status = -EINPROGRESS;
838 hwreq->req.actual = 0;
839
840 retval = _hardware_enqueue(hwep, hwreq);
841
842 if (retval == -EALREADY)
843 retval = 0;
844 if (!retval)
845 list_add_tail(&hwreq->queue, &hwep->qh.queue);
846
847 return retval;
848 }
849
850 /**
851 * isr_get_status_response: get_status request response
852 * @ci: ci struct
853 * @setup: setup request packet
854 *
855 * This function returns an error code
856 */
857 static int isr_get_status_response(struct ci_hdrc *ci,
858 struct usb_ctrlrequest *setup)
859 __releases(hwep->lock)
860 __acquires(hwep->lock)
861 {
862 struct ci_hw_ep *hwep = ci->ep0in;
863 struct usb_request *req = NULL;
864 gfp_t gfp_flags = GFP_ATOMIC;
865 int dir, num, retval;
866
867 if (hwep == NULL || setup == NULL)
868 return -EINVAL;
869
870 spin_unlock(hwep->lock);
871 req = usb_ep_alloc_request(&hwep->ep, gfp_flags);
872 spin_lock(hwep->lock);
873 if (req == NULL)
874 return -ENOMEM;
875
876 req->complete = isr_get_status_complete;
877 req->length = 2;
878 req->buf = kzalloc(req->length, gfp_flags);
879 if (req->buf == NULL) {
880 retval = -ENOMEM;
881 goto err_free_req;
882 }
883
884 if ((setup->bRequestType & USB_RECIP_MASK) == USB_RECIP_DEVICE) {
885 *(u16 *)req->buf = (ci->remote_wakeup << 1) |
886 ci->gadget.is_selfpowered;
887 } else if ((setup->bRequestType & USB_RECIP_MASK) \
888 == USB_RECIP_ENDPOINT) {
889 dir = (le16_to_cpu(setup->wIndex) & USB_ENDPOINT_DIR_MASK) ?
890 TX : RX;
891 num = le16_to_cpu(setup->wIndex) & USB_ENDPOINT_NUMBER_MASK;
892 *(u16 *)req->buf = hw_ep_get_halt(ci, num, dir);
893 }
894 /* else do nothing; reserved for future use */
895
896 retval = _ep_queue(&hwep->ep, req, gfp_flags);
897 if (retval)
898 goto err_free_buf;
899
900 return 0;
901
902 err_free_buf:
903 kfree(req->buf);
904 err_free_req:
905 spin_unlock(hwep->lock);
906 usb_ep_free_request(&hwep->ep, req);
907 spin_lock(hwep->lock);
908 return retval;
909 }
910
911 /**
912 * isr_setup_status_complete: setup_status request complete function
913 * @ep: endpoint
914 * @req: request handled
915 *
916 * Caller must release lock. Put the port in test mode if test mode
917 * feature is selected.
918 */
919 static void
920 isr_setup_status_complete(struct usb_ep *ep, struct usb_request *req)
921 {
922 struct ci_hdrc *ci = req->context;
923 unsigned long flags;
924
925 if (ci->setaddr) {
926 hw_usb_set_address(ci, ci->address);
927 ci->setaddr = false;
928 if (ci->address)
929 usb_gadget_set_state(&ci->gadget, USB_STATE_ADDRESS);
930 }
931
932 spin_lock_irqsave(&ci->lock, flags);
933 if (ci->test_mode)
934 hw_port_test_set(ci, ci->test_mode);
935 spin_unlock_irqrestore(&ci->lock, flags);
936 }
937
938 /**
939 * isr_setup_status_phase: queues the status phase of a setup transation
940 * @ci: ci struct
941 *
942 * This function returns an error code
943 */
944 static int isr_setup_status_phase(struct ci_hdrc *ci)
945 {
946 int retval;
947 struct ci_hw_ep *hwep;
948
949 /*
950 * Unexpected USB controller behavior, caused by bad signal integrity
951 * or ground reference problems, can lead to isr_setup_status_phase
952 * being called with ci->status equal to NULL.
953 * If this situation occurs, you should review your USB hardware design.
954 */
955 if (WARN_ON_ONCE(!ci->status))
956 return -EPIPE;
957
958 hwep = (ci->ep0_dir == TX) ? ci->ep0out : ci->ep0in;
959 ci->status->context = ci;
960 ci->status->complete = isr_setup_status_complete;
961
962 retval = _ep_queue(&hwep->ep, ci->status, GFP_ATOMIC);
963
964 return retval;
965 }
966
967 /**
968 * isr_tr_complete_low: transaction complete low level handler
969 * @hwep: endpoint
970 *
971 * This function returns an error code
972 * Caller must hold lock
973 */
974 static int isr_tr_complete_low(struct ci_hw_ep *hwep)
975 __releases(hwep->lock)
976 __acquires(hwep->lock)
977 {
978 struct ci_hw_req *hwreq, *hwreqtemp;
979 struct ci_hw_ep *hweptemp = hwep;
980 int retval = 0;
981
982 list_for_each_entry_safe(hwreq, hwreqtemp, &hwep->qh.queue,
983 queue) {
984 retval = _hardware_dequeue(hwep, hwreq);
985 if (retval < 0)
986 break;
987 list_del_init(&hwreq->queue);
988 if (hwreq->req.complete != NULL) {
989 spin_unlock(hwep->lock);
990 if ((hwep->type == USB_ENDPOINT_XFER_CONTROL) &&
991 hwreq->req.length)
992 hweptemp = hwep->ci->ep0in;
993 usb_gadget_giveback_request(&hweptemp->ep, &hwreq->req);
994 spin_lock(hwep->lock);
995 }
996 }
997
998 if (retval == -EBUSY)
999 retval = 0;
1000
1001 return retval;
1002 }
1003
1004 static int otg_a_alt_hnp_support(struct ci_hdrc *ci)
1005 {
1006 dev_warn(&ci->gadget.dev,
1007 "connect the device to an alternate port if you want HNP\n");
1008 return isr_setup_status_phase(ci);
1009 }
1010
1011 /**
1012 * isr_setup_packet_handler: setup packet handler
1013 * @ci: UDC descriptor
1014 *
1015 * This function handles setup packet
1016 */
1017 static void isr_setup_packet_handler(struct ci_hdrc *ci)
1018 __releases(ci->lock)
1019 __acquires(ci->lock)
1020 {
1021 struct ci_hw_ep *hwep = &ci->ci_hw_ep[0];
1022 struct usb_ctrlrequest req;
1023 int type, num, dir, err = -EINVAL;
1024 u8 tmode = 0;
1025
1026 /*
1027 * Flush data and handshake transactions of previous
1028 * setup packet.
1029 */
1030 _ep_nuke(ci->ep0out);
1031 _ep_nuke(ci->ep0in);
1032
1033 /* read_setup_packet */
1034 do {
1035 hw_test_and_set_setup_guard(ci);
1036 memcpy(&req, &hwep->qh.ptr->setup, sizeof(req));
1037 } while (!hw_test_and_clear_setup_guard(ci));
1038
1039 type = req.bRequestType;
1040
1041 ci->ep0_dir = (type & USB_DIR_IN) ? TX : RX;
1042
1043 switch (req.bRequest) {
1044 case USB_REQ_CLEAR_FEATURE:
1045 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1046 le16_to_cpu(req.wValue) ==
1047 USB_ENDPOINT_HALT) {
1048 if (req.wLength != 0)
1049 break;
1050 num = le16_to_cpu(req.wIndex);
1051 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1052 num &= USB_ENDPOINT_NUMBER_MASK;
1053 if (dir == TX)
1054 num += ci->hw_ep_max / 2;
1055 if (!ci->ci_hw_ep[num].wedge) {
1056 spin_unlock(&ci->lock);
1057 err = usb_ep_clear_halt(
1058 &ci->ci_hw_ep[num].ep);
1059 spin_lock(&ci->lock);
1060 if (err)
1061 break;
1062 }
1063 err = isr_setup_status_phase(ci);
1064 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE) &&
1065 le16_to_cpu(req.wValue) ==
1066 USB_DEVICE_REMOTE_WAKEUP) {
1067 if (req.wLength != 0)
1068 break;
1069 ci->remote_wakeup = 0;
1070 err = isr_setup_status_phase(ci);
1071 } else {
1072 goto delegate;
1073 }
1074 break;
1075 case USB_REQ_GET_STATUS:
1076 if ((type != (USB_DIR_IN|USB_RECIP_DEVICE) ||
1077 le16_to_cpu(req.wIndex) == OTG_STS_SELECTOR) &&
1078 type != (USB_DIR_IN|USB_RECIP_ENDPOINT) &&
1079 type != (USB_DIR_IN|USB_RECIP_INTERFACE))
1080 goto delegate;
1081 if (le16_to_cpu(req.wLength) != 2 ||
1082 le16_to_cpu(req.wValue) != 0)
1083 break;
1084 err = isr_get_status_response(ci, &req);
1085 break;
1086 case USB_REQ_SET_ADDRESS:
1087 if (type != (USB_DIR_OUT|USB_RECIP_DEVICE))
1088 goto delegate;
1089 if (le16_to_cpu(req.wLength) != 0 ||
1090 le16_to_cpu(req.wIndex) != 0)
1091 break;
1092 ci->address = (u8)le16_to_cpu(req.wValue);
1093 ci->setaddr = true;
1094 err = isr_setup_status_phase(ci);
1095 break;
1096 case USB_REQ_SET_FEATURE:
1097 if (type == (USB_DIR_OUT|USB_RECIP_ENDPOINT) &&
1098 le16_to_cpu(req.wValue) ==
1099 USB_ENDPOINT_HALT) {
1100 if (req.wLength != 0)
1101 break;
1102 num = le16_to_cpu(req.wIndex);
1103 dir = (num & USB_ENDPOINT_DIR_MASK) ? TX : RX;
1104 num &= USB_ENDPOINT_NUMBER_MASK;
1105 if (dir == TX)
1106 num += ci->hw_ep_max / 2;
1107
1108 spin_unlock(&ci->lock);
1109 err = _ep_set_halt(&ci->ci_hw_ep[num].ep, 1, false);
1110 spin_lock(&ci->lock);
1111 if (!err)
1112 isr_setup_status_phase(ci);
1113 } else if (type == (USB_DIR_OUT|USB_RECIP_DEVICE)) {
1114 if (req.wLength != 0)
1115 break;
1116 switch (le16_to_cpu(req.wValue)) {
1117 case USB_DEVICE_REMOTE_WAKEUP:
1118 ci->remote_wakeup = 1;
1119 err = isr_setup_status_phase(ci);
1120 break;
1121 case USB_DEVICE_TEST_MODE:
1122 tmode = le16_to_cpu(req.wIndex) >> 8;
1123 switch (tmode) {
1124 case TEST_J:
1125 case TEST_K:
1126 case TEST_SE0_NAK:
1127 case TEST_PACKET:
1128 case TEST_FORCE_EN:
1129 ci->test_mode = tmode;
1130 err = isr_setup_status_phase(
1131 ci);
1132 break;
1133 default:
1134 break;
1135 }
1136 break;
1137 case USB_DEVICE_B_HNP_ENABLE:
1138 if (ci_otg_is_fsm_mode(ci)) {
1139 ci->gadget.b_hnp_enable = 1;
1140 err = isr_setup_status_phase(
1141 ci);
1142 }
1143 break;
1144 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1145 if (ci_otg_is_fsm_mode(ci))
1146 err = otg_a_alt_hnp_support(ci);
1147 break;
1148 case USB_DEVICE_A_HNP_SUPPORT:
1149 if (ci_otg_is_fsm_mode(ci)) {
1150 ci->gadget.a_hnp_support = 1;
1151 err = isr_setup_status_phase(
1152 ci);
1153 }
1154 break;
1155 default:
1156 goto delegate;
1157 }
1158 } else {
1159 goto delegate;
1160 }
1161 break;
1162 default:
1163 delegate:
1164 if (req.wLength == 0) /* no data phase */
1165 ci->ep0_dir = TX;
1166
1167 spin_unlock(&ci->lock);
1168 err = ci->driver->setup(&ci->gadget, &req);
1169 spin_lock(&ci->lock);
1170 break;
1171 }
1172
1173 if (err < 0) {
1174 spin_unlock(&ci->lock);
1175 if (_ep_set_halt(&hwep->ep, 1, false))
1176 dev_err(ci->dev, "error: _ep_set_halt\n");
1177 spin_lock(&ci->lock);
1178 }
1179 }
1180
1181 /**
1182 * isr_tr_complete_handler: transaction complete interrupt handler
1183 * @ci: UDC descriptor
1184 *
1185 * This function handles traffic events
1186 */
1187 static void isr_tr_complete_handler(struct ci_hdrc *ci)
1188 __releases(ci->lock)
1189 __acquires(ci->lock)
1190 {
1191 unsigned i;
1192 int err;
1193
1194 for (i = 0; i < ci->hw_ep_max; i++) {
1195 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1196
1197 if (hwep->ep.desc == NULL)
1198 continue; /* not configured */
1199
1200 if (hw_test_and_clear_complete(ci, i)) {
1201 err = isr_tr_complete_low(hwep);
1202 if (hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1203 if (err > 0) /* needs status phase */
1204 err = isr_setup_status_phase(ci);
1205 if (err < 0) {
1206 spin_unlock(&ci->lock);
1207 if (_ep_set_halt(&hwep->ep, 1, false))
1208 dev_err(ci->dev,
1209 "error: _ep_set_halt\n");
1210 spin_lock(&ci->lock);
1211 }
1212 }
1213 }
1214
1215 /* Only handle setup packet below */
1216 if (i == 0 &&
1217 hw_test_and_clear(ci, OP_ENDPTSETUPSTAT, BIT(0)))
1218 isr_setup_packet_handler(ci);
1219 }
1220 }
1221
1222 /******************************************************************************
1223 * ENDPT block
1224 *****************************************************************************/
1225 /**
1226 * ep_enable: configure endpoint, making it usable
1227 *
1228 * Check usb_ep_enable() at "usb_gadget.h" for details
1229 */
1230 static int ep_enable(struct usb_ep *ep,
1231 const struct usb_endpoint_descriptor *desc)
1232 {
1233 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1234 int retval = 0;
1235 unsigned long flags;
1236 u32 cap = 0;
1237
1238 if (ep == NULL || desc == NULL)
1239 return -EINVAL;
1240
1241 spin_lock_irqsave(hwep->lock, flags);
1242
1243 /* only internal SW should enable ctrl endpts */
1244
1245 if (!list_empty(&hwep->qh.queue)) {
1246 dev_warn(hwep->ci->dev, "enabling a non-empty endpoint!\n");
1247 spin_unlock_irqrestore(hwep->lock, flags);
1248 return -EBUSY;
1249 }
1250
1251 hwep->ep.desc = desc;
1252
1253 hwep->dir = usb_endpoint_dir_in(desc) ? TX : RX;
1254 hwep->num = usb_endpoint_num(desc);
1255 hwep->type = usb_endpoint_type(desc);
1256
1257 hwep->ep.maxpacket = usb_endpoint_maxp(desc) & 0x07ff;
1258 hwep->ep.mult = QH_ISO_MULT(usb_endpoint_maxp(desc));
1259
1260 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1261 cap |= QH_IOS;
1262
1263 cap |= QH_ZLT;
1264 cap |= (hwep->ep.maxpacket << __ffs(QH_MAX_PKT)) & QH_MAX_PKT;
1265 /*
1266 * For ISO-TX, we set mult at QH as the largest value, and use
1267 * MultO at TD as real mult value.
1268 */
1269 if (hwep->type == USB_ENDPOINT_XFER_ISOC && hwep->dir == TX)
1270 cap |= 3 << __ffs(QH_MULT);
1271
1272 hwep->qh.ptr->cap = cpu_to_le32(cap);
1273
1274 hwep->qh.ptr->td.next |= cpu_to_le32(TD_TERMINATE); /* needed? */
1275
1276 if (hwep->num != 0 && hwep->type == USB_ENDPOINT_XFER_CONTROL) {
1277 dev_err(hwep->ci->dev, "Set control xfer at non-ep0\n");
1278 retval = -EINVAL;
1279 }
1280
1281 /*
1282 * Enable endpoints in the HW other than ep0 as ep0
1283 * is always enabled
1284 */
1285 if (hwep->num)
1286 retval |= hw_ep_enable(hwep->ci, hwep->num, hwep->dir,
1287 hwep->type);
1288
1289 spin_unlock_irqrestore(hwep->lock, flags);
1290 return retval;
1291 }
1292
1293 /**
1294 * ep_disable: endpoint is no longer usable
1295 *
1296 * Check usb_ep_disable() at "usb_gadget.h" for details
1297 */
1298 static int ep_disable(struct usb_ep *ep)
1299 {
1300 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1301 int direction, retval = 0;
1302 unsigned long flags;
1303
1304 if (ep == NULL)
1305 return -EINVAL;
1306 else if (hwep->ep.desc == NULL)
1307 return -EBUSY;
1308
1309 spin_lock_irqsave(hwep->lock, flags);
1310
1311 /* only internal SW should disable ctrl endpts */
1312
1313 direction = hwep->dir;
1314 do {
1315 retval |= _ep_nuke(hwep);
1316 retval |= hw_ep_disable(hwep->ci, hwep->num, hwep->dir);
1317
1318 if (hwep->type == USB_ENDPOINT_XFER_CONTROL)
1319 hwep->dir = (hwep->dir == TX) ? RX : TX;
1320
1321 } while (hwep->dir != direction);
1322
1323 hwep->ep.desc = NULL;
1324
1325 spin_unlock_irqrestore(hwep->lock, flags);
1326 return retval;
1327 }
1328
1329 /**
1330 * ep_alloc_request: allocate a request object to use with this endpoint
1331 *
1332 * Check usb_ep_alloc_request() at "usb_gadget.h" for details
1333 */
1334 static struct usb_request *ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1335 {
1336 struct ci_hw_req *hwreq = NULL;
1337
1338 if (ep == NULL)
1339 return NULL;
1340
1341 hwreq = kzalloc(sizeof(struct ci_hw_req), gfp_flags);
1342 if (hwreq != NULL) {
1343 INIT_LIST_HEAD(&hwreq->queue);
1344 INIT_LIST_HEAD(&hwreq->tds);
1345 }
1346
1347 return (hwreq == NULL) ? NULL : &hwreq->req;
1348 }
1349
1350 /**
1351 * ep_free_request: frees a request object
1352 *
1353 * Check usb_ep_free_request() at "usb_gadget.h" for details
1354 */
1355 static void ep_free_request(struct usb_ep *ep, struct usb_request *req)
1356 {
1357 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1358 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1359 struct td_node *node, *tmpnode;
1360 unsigned long flags;
1361
1362 if (ep == NULL || req == NULL) {
1363 return;
1364 } else if (!list_empty(&hwreq->queue)) {
1365 dev_err(hwep->ci->dev, "freeing queued request\n");
1366 return;
1367 }
1368
1369 spin_lock_irqsave(hwep->lock, flags);
1370
1371 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1372 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1373 list_del_init(&node->td);
1374 node->ptr = NULL;
1375 kfree(node);
1376 }
1377
1378 kfree(hwreq);
1379
1380 spin_unlock_irqrestore(hwep->lock, flags);
1381 }
1382
1383 /**
1384 * ep_queue: queues (submits) an I/O request to an endpoint
1385 *
1386 * Check usb_ep_queue()* at usb_gadget.h" for details
1387 */
1388 static int ep_queue(struct usb_ep *ep, struct usb_request *req,
1389 gfp_t __maybe_unused gfp_flags)
1390 {
1391 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1392 int retval = 0;
1393 unsigned long flags;
1394
1395 if (ep == NULL || req == NULL || hwep->ep.desc == NULL)
1396 return -EINVAL;
1397
1398 spin_lock_irqsave(hwep->lock, flags);
1399 retval = _ep_queue(ep, req, gfp_flags);
1400 spin_unlock_irqrestore(hwep->lock, flags);
1401 return retval;
1402 }
1403
1404 /**
1405 * ep_dequeue: dequeues (cancels, unlinks) an I/O request from an endpoint
1406 *
1407 * Check usb_ep_dequeue() at "usb_gadget.h" for details
1408 */
1409 static int ep_dequeue(struct usb_ep *ep, struct usb_request *req)
1410 {
1411 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1412 struct ci_hw_req *hwreq = container_of(req, struct ci_hw_req, req);
1413 unsigned long flags;
1414 struct td_node *node, *tmpnode;
1415
1416 if (ep == NULL || req == NULL || hwreq->req.status != -EALREADY ||
1417 hwep->ep.desc == NULL || list_empty(&hwreq->queue) ||
1418 list_empty(&hwep->qh.queue))
1419 return -EINVAL;
1420
1421 spin_lock_irqsave(hwep->lock, flags);
1422
1423 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1424
1425 list_for_each_entry_safe(node, tmpnode, &hwreq->tds, td) {
1426 dma_pool_free(hwep->td_pool, node->ptr, node->dma);
1427 list_del(&node->td);
1428 kfree(node);
1429 }
1430
1431 /* pop request */
1432 list_del_init(&hwreq->queue);
1433
1434 usb_gadget_unmap_request(&hwep->ci->gadget, req, hwep->dir);
1435
1436 req->status = -ECONNRESET;
1437
1438 if (hwreq->req.complete != NULL) {
1439 spin_unlock(hwep->lock);
1440 usb_gadget_giveback_request(&hwep->ep, &hwreq->req);
1441 spin_lock(hwep->lock);
1442 }
1443
1444 spin_unlock_irqrestore(hwep->lock, flags);
1445 return 0;
1446 }
1447
1448 /**
1449 * ep_set_halt: sets the endpoint halt feature
1450 *
1451 * Check usb_ep_set_halt() at "usb_gadget.h" for details
1452 */
1453 static int ep_set_halt(struct usb_ep *ep, int value)
1454 {
1455 return _ep_set_halt(ep, value, true);
1456 }
1457
1458 /**
1459 * ep_set_wedge: sets the halt feature and ignores clear requests
1460 *
1461 * Check usb_ep_set_wedge() at "usb_gadget.h" for details
1462 */
1463 static int ep_set_wedge(struct usb_ep *ep)
1464 {
1465 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1466 unsigned long flags;
1467
1468 if (ep == NULL || hwep->ep.desc == NULL)
1469 return -EINVAL;
1470
1471 spin_lock_irqsave(hwep->lock, flags);
1472 hwep->wedge = 1;
1473 spin_unlock_irqrestore(hwep->lock, flags);
1474
1475 return usb_ep_set_halt(ep);
1476 }
1477
1478 /**
1479 * ep_fifo_flush: flushes contents of a fifo
1480 *
1481 * Check usb_ep_fifo_flush() at "usb_gadget.h" for details
1482 */
1483 static void ep_fifo_flush(struct usb_ep *ep)
1484 {
1485 struct ci_hw_ep *hwep = container_of(ep, struct ci_hw_ep, ep);
1486 unsigned long flags;
1487
1488 if (ep == NULL) {
1489 dev_err(hwep->ci->dev, "%02X: -EINVAL\n", _usb_addr(hwep));
1490 return;
1491 }
1492
1493 spin_lock_irqsave(hwep->lock, flags);
1494
1495 hw_ep_flush(hwep->ci, hwep->num, hwep->dir);
1496
1497 spin_unlock_irqrestore(hwep->lock, flags);
1498 }
1499
1500 /**
1501 * Endpoint-specific part of the API to the USB controller hardware
1502 * Check "usb_gadget.h" for details
1503 */
1504 static const struct usb_ep_ops usb_ep_ops = {
1505 .enable = ep_enable,
1506 .disable = ep_disable,
1507 .alloc_request = ep_alloc_request,
1508 .free_request = ep_free_request,
1509 .queue = ep_queue,
1510 .dequeue = ep_dequeue,
1511 .set_halt = ep_set_halt,
1512 .set_wedge = ep_set_wedge,
1513 .fifo_flush = ep_fifo_flush,
1514 };
1515
1516 /******************************************************************************
1517 * GADGET block
1518 *****************************************************************************/
1519 static int ci_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1520 {
1521 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1522 unsigned long flags;
1523 int gadget_ready = 0;
1524
1525 spin_lock_irqsave(&ci->lock, flags);
1526 ci->vbus_active = is_active;
1527 if (ci->driver)
1528 gadget_ready = 1;
1529 spin_unlock_irqrestore(&ci->lock, flags);
1530
1531 if (gadget_ready) {
1532 if (is_active) {
1533 pm_runtime_get_sync(&_gadget->dev);
1534 hw_device_reset(ci);
1535 hw_device_state(ci, ci->ep0out->qh.dma);
1536 usb_gadget_set_state(_gadget, USB_STATE_POWERED);
1537 usb_udc_vbus_handler(_gadget, true);
1538 } else {
1539 usb_udc_vbus_handler(_gadget, false);
1540 if (ci->driver)
1541 ci->driver->disconnect(&ci->gadget);
1542 hw_device_state(ci, 0);
1543 if (ci->platdata->notify_event)
1544 ci->platdata->notify_event(ci,
1545 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1546 _gadget_stop_activity(&ci->gadget);
1547 pm_runtime_put_sync(&_gadget->dev);
1548 usb_gadget_set_state(_gadget, USB_STATE_NOTATTACHED);
1549 }
1550 }
1551
1552 return 0;
1553 }
1554
1555 static int ci_udc_wakeup(struct usb_gadget *_gadget)
1556 {
1557 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1558 unsigned long flags;
1559 int ret = 0;
1560
1561 spin_lock_irqsave(&ci->lock, flags);
1562 if (!ci->remote_wakeup) {
1563 ret = -EOPNOTSUPP;
1564 goto out;
1565 }
1566 if (!hw_read(ci, OP_PORTSC, PORTSC_SUSP)) {
1567 ret = -EINVAL;
1568 goto out;
1569 }
1570 hw_write(ci, OP_PORTSC, PORTSC_FPR, PORTSC_FPR);
1571 out:
1572 spin_unlock_irqrestore(&ci->lock, flags);
1573 return ret;
1574 }
1575
1576 static int ci_udc_vbus_draw(struct usb_gadget *_gadget, unsigned ma)
1577 {
1578 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1579
1580 if (ci->usb_phy)
1581 return usb_phy_set_power(ci->usb_phy, ma);
1582 return -ENOTSUPP;
1583 }
1584
1585 static int ci_udc_selfpowered(struct usb_gadget *_gadget, int is_on)
1586 {
1587 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1588 struct ci_hw_ep *hwep = ci->ep0in;
1589 unsigned long flags;
1590
1591 spin_lock_irqsave(hwep->lock, flags);
1592 _gadget->is_selfpowered = (is_on != 0);
1593 spin_unlock_irqrestore(hwep->lock, flags);
1594
1595 return 0;
1596 }
1597
1598 /* Change Data+ pullup status
1599 * this func is used by usb_gadget_connect/disconnet
1600 */
1601 static int ci_udc_pullup(struct usb_gadget *_gadget, int is_on)
1602 {
1603 struct ci_hdrc *ci = container_of(_gadget, struct ci_hdrc, gadget);
1604
1605 /*
1606 * Data+ pullup controlled by OTG state machine in OTG fsm mode;
1607 * and don't touch Data+ in host mode for dual role config.
1608 */
1609 if (ci_otg_is_fsm_mode(ci) || ci->role == CI_ROLE_HOST)
1610 return 0;
1611
1612 pm_runtime_get_sync(&ci->gadget.dev);
1613 if (is_on)
1614 hw_write(ci, OP_USBCMD, USBCMD_RS, USBCMD_RS);
1615 else
1616 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
1617 pm_runtime_put_sync(&ci->gadget.dev);
1618
1619 return 0;
1620 }
1621
1622 static int ci_udc_start(struct usb_gadget *gadget,
1623 struct usb_gadget_driver *driver);
1624 static int ci_udc_stop(struct usb_gadget *gadget);
1625 /**
1626 * Device operations part of the API to the USB controller hardware,
1627 * which don't involve endpoints (or i/o)
1628 * Check "usb_gadget.h" for details
1629 */
1630 static const struct usb_gadget_ops usb_gadget_ops = {
1631 .vbus_session = ci_udc_vbus_session,
1632 .wakeup = ci_udc_wakeup,
1633 .set_selfpowered = ci_udc_selfpowered,
1634 .pullup = ci_udc_pullup,
1635 .vbus_draw = ci_udc_vbus_draw,
1636 .udc_start = ci_udc_start,
1637 .udc_stop = ci_udc_stop,
1638 };
1639
1640 static int init_eps(struct ci_hdrc *ci)
1641 {
1642 int retval = 0, i, j;
1643
1644 for (i = 0; i < ci->hw_ep_max/2; i++)
1645 for (j = RX; j <= TX; j++) {
1646 int k = i + j * ci->hw_ep_max/2;
1647 struct ci_hw_ep *hwep = &ci->ci_hw_ep[k];
1648
1649 scnprintf(hwep->name, sizeof(hwep->name), "ep%i%s", i,
1650 (j == TX) ? "in" : "out");
1651
1652 hwep->ci = ci;
1653 hwep->lock = &ci->lock;
1654 hwep->td_pool = ci->td_pool;
1655
1656 hwep->ep.name = hwep->name;
1657 hwep->ep.ops = &usb_ep_ops;
1658
1659 if (i == 0) {
1660 hwep->ep.caps.type_control = true;
1661 } else {
1662 hwep->ep.caps.type_iso = true;
1663 hwep->ep.caps.type_bulk = true;
1664 hwep->ep.caps.type_int = true;
1665 }
1666
1667 if (j == TX)
1668 hwep->ep.caps.dir_in = true;
1669 else
1670 hwep->ep.caps.dir_out = true;
1671
1672 /*
1673 * for ep0: maxP defined in desc, for other
1674 * eps, maxP is set by epautoconfig() called
1675 * by gadget layer
1676 */
1677 usb_ep_set_maxpacket_limit(&hwep->ep, (unsigned short)~0);
1678
1679 INIT_LIST_HEAD(&hwep->qh.queue);
1680 hwep->qh.ptr = dma_pool_alloc(ci->qh_pool, GFP_KERNEL,
1681 &hwep->qh.dma);
1682 if (hwep->qh.ptr == NULL)
1683 retval = -ENOMEM;
1684 else
1685 memset(hwep->qh.ptr, 0, sizeof(*hwep->qh.ptr));
1686
1687 /*
1688 * set up shorthands for ep0 out and in endpoints,
1689 * don't add to gadget's ep_list
1690 */
1691 if (i == 0) {
1692 if (j == RX)
1693 ci->ep0out = hwep;
1694 else
1695 ci->ep0in = hwep;
1696
1697 usb_ep_set_maxpacket_limit(&hwep->ep, CTRL_PAYLOAD_MAX);
1698 continue;
1699 }
1700
1701 list_add_tail(&hwep->ep.ep_list, &ci->gadget.ep_list);
1702 }
1703
1704 return retval;
1705 }
1706
1707 static void destroy_eps(struct ci_hdrc *ci)
1708 {
1709 int i;
1710
1711 for (i = 0; i < ci->hw_ep_max; i++) {
1712 struct ci_hw_ep *hwep = &ci->ci_hw_ep[i];
1713
1714 if (hwep->pending_td)
1715 free_pending_td(hwep);
1716 dma_pool_free(ci->qh_pool, hwep->qh.ptr, hwep->qh.dma);
1717 }
1718 }
1719
1720 /**
1721 * ci_udc_start: register a gadget driver
1722 * @gadget: our gadget
1723 * @driver: the driver being registered
1724 *
1725 * Interrupts are enabled here.
1726 */
1727 static int ci_udc_start(struct usb_gadget *gadget,
1728 struct usb_gadget_driver *driver)
1729 {
1730 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1731 unsigned long flags;
1732 int retval = -ENOMEM;
1733
1734 if (driver->disconnect == NULL)
1735 return -EINVAL;
1736
1737
1738 ci->ep0out->ep.desc = &ctrl_endpt_out_desc;
1739 retval = usb_ep_enable(&ci->ep0out->ep);
1740 if (retval)
1741 return retval;
1742
1743 ci->ep0in->ep.desc = &ctrl_endpt_in_desc;
1744 retval = usb_ep_enable(&ci->ep0in->ep);
1745 if (retval)
1746 return retval;
1747
1748 ci->driver = driver;
1749
1750 /* Start otg fsm for B-device */
1751 if (ci_otg_is_fsm_mode(ci) && ci->fsm.id) {
1752 ci_hdrc_otg_fsm_start(ci);
1753 return retval;
1754 }
1755
1756 pm_runtime_get_sync(&ci->gadget.dev);
1757 if (ci->vbus_active) {
1758 spin_lock_irqsave(&ci->lock, flags);
1759 hw_device_reset(ci);
1760 } else {
1761 usb_udc_vbus_handler(&ci->gadget, false);
1762 pm_runtime_put_sync(&ci->gadget.dev);
1763 return retval;
1764 }
1765
1766 retval = hw_device_state(ci, ci->ep0out->qh.dma);
1767 spin_unlock_irqrestore(&ci->lock, flags);
1768 if (retval)
1769 pm_runtime_put_sync(&ci->gadget.dev);
1770
1771 return retval;
1772 }
1773
1774 static void ci_udc_stop_for_otg_fsm(struct ci_hdrc *ci)
1775 {
1776 if (!ci_otg_is_fsm_mode(ci))
1777 return;
1778
1779 mutex_lock(&ci->fsm.lock);
1780 if (ci->fsm.otg->state == OTG_STATE_A_PERIPHERAL) {
1781 ci->fsm.a_bidl_adis_tmout = 1;
1782 ci_hdrc_otg_fsm_start(ci);
1783 } else if (ci->fsm.otg->state == OTG_STATE_B_PERIPHERAL) {
1784 ci->fsm.protocol = PROTO_UNDEF;
1785 ci->fsm.otg->state = OTG_STATE_UNDEFINED;
1786 }
1787 mutex_unlock(&ci->fsm.lock);
1788 }
1789
1790 /**
1791 * ci_udc_stop: unregister a gadget driver
1792 */
1793 static int ci_udc_stop(struct usb_gadget *gadget)
1794 {
1795 struct ci_hdrc *ci = container_of(gadget, struct ci_hdrc, gadget);
1796 unsigned long flags;
1797
1798 spin_lock_irqsave(&ci->lock, flags);
1799
1800 if (ci->vbus_active) {
1801 hw_device_state(ci, 0);
1802 if (ci->platdata->notify_event)
1803 ci->platdata->notify_event(ci,
1804 CI_HDRC_CONTROLLER_STOPPED_EVENT);
1805 spin_unlock_irqrestore(&ci->lock, flags);
1806 _gadget_stop_activity(&ci->gadget);
1807 spin_lock_irqsave(&ci->lock, flags);
1808 pm_runtime_put(&ci->gadget.dev);
1809 }
1810
1811 ci->driver = NULL;
1812 spin_unlock_irqrestore(&ci->lock, flags);
1813
1814 ci_udc_stop_for_otg_fsm(ci);
1815 return 0;
1816 }
1817
1818 /******************************************************************************
1819 * BUS block
1820 *****************************************************************************/
1821 /**
1822 * udc_irq: ci interrupt handler
1823 *
1824 * This function returns IRQ_HANDLED if the IRQ has been handled
1825 * It locks access to registers
1826 */
1827 static irqreturn_t udc_irq(struct ci_hdrc *ci)
1828 {
1829 irqreturn_t retval;
1830 u32 intr;
1831
1832 if (ci == NULL)
1833 return IRQ_HANDLED;
1834
1835 spin_lock(&ci->lock);
1836
1837 if (ci->platdata->flags & CI_HDRC_REGS_SHARED) {
1838 if (hw_read(ci, OP_USBMODE, USBMODE_CM) !=
1839 USBMODE_CM_DC) {
1840 spin_unlock(&ci->lock);
1841 return IRQ_NONE;
1842 }
1843 }
1844 intr = hw_test_and_clear_intr_active(ci);
1845
1846 if (intr) {
1847 /* order defines priority - do NOT change it */
1848 if (USBi_URI & intr)
1849 isr_reset_handler(ci);
1850
1851 if (USBi_PCI & intr) {
1852 ci->gadget.speed = hw_port_is_high_speed(ci) ?
1853 USB_SPEED_HIGH : USB_SPEED_FULL;
1854 if (ci->suspended && ci->driver->resume) {
1855 spin_unlock(&ci->lock);
1856 ci->driver->resume(&ci->gadget);
1857 spin_lock(&ci->lock);
1858 ci->suspended = 0;
1859 }
1860 }
1861
1862 if (USBi_UI & intr)
1863 isr_tr_complete_handler(ci);
1864
1865 if (USBi_SLI & intr) {
1866 if (ci->gadget.speed != USB_SPEED_UNKNOWN &&
1867 ci->driver->suspend) {
1868 ci->suspended = 1;
1869 spin_unlock(&ci->lock);
1870 ci->driver->suspend(&ci->gadget);
1871 usb_gadget_set_state(&ci->gadget,
1872 USB_STATE_SUSPENDED);
1873 spin_lock(&ci->lock);
1874 }
1875 }
1876 retval = IRQ_HANDLED;
1877 } else {
1878 retval = IRQ_NONE;
1879 }
1880 spin_unlock(&ci->lock);
1881
1882 return retval;
1883 }
1884
1885 /**
1886 * udc_start: initialize gadget role
1887 * @ci: chipidea controller
1888 */
1889 static int udc_start(struct ci_hdrc *ci)
1890 {
1891 struct device *dev = ci->dev;
1892 struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;
1893 int retval = 0;
1894
1895 spin_lock_init(&ci->lock);
1896
1897 ci->gadget.ops = &usb_gadget_ops;
1898 ci->gadget.speed = USB_SPEED_UNKNOWN;
1899 ci->gadget.max_speed = USB_SPEED_HIGH;
1900 ci->gadget.name = ci->platdata->name;
1901 ci->gadget.otg_caps = otg_caps;
1902
1903 if (ci->is_otg && (otg_caps->hnp_support || otg_caps->srp_support ||
1904 otg_caps->adp_support))
1905 ci->gadget.is_otg = 1;
1906
1907 INIT_LIST_HEAD(&ci->gadget.ep_list);
1908
1909 /* alloc resources */
1910 ci->qh_pool = dma_pool_create("ci_hw_qh", dev,
1911 sizeof(struct ci_hw_qh),
1912 64, CI_HDRC_PAGE_SIZE);
1913 if (ci->qh_pool == NULL)
1914 return -ENOMEM;
1915
1916 ci->td_pool = dma_pool_create("ci_hw_td", dev,
1917 sizeof(struct ci_hw_td),
1918 64, CI_HDRC_PAGE_SIZE);
1919 if (ci->td_pool == NULL) {
1920 retval = -ENOMEM;
1921 goto free_qh_pool;
1922 }
1923
1924 retval = init_eps(ci);
1925 if (retval)
1926 goto free_pools;
1927
1928 ci->gadget.ep0 = &ci->ep0in->ep;
1929
1930 retval = usb_add_gadget_udc(dev, &ci->gadget);
1931 if (retval)
1932 goto destroy_eps;
1933
1934 pm_runtime_no_callbacks(&ci->gadget.dev);
1935 pm_runtime_enable(&ci->gadget.dev);
1936
1937 return retval;
1938
1939 destroy_eps:
1940 destroy_eps(ci);
1941 free_pools:
1942 dma_pool_destroy(ci->td_pool);
1943 free_qh_pool:
1944 dma_pool_destroy(ci->qh_pool);
1945 return retval;
1946 }
1947
1948 /**
1949 * ci_hdrc_gadget_destroy: parent remove must call this to remove UDC
1950 *
1951 * No interrupts active, the IRQ has been released
1952 */
1953 void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
1954 {
1955 if (!ci->roles[CI_ROLE_GADGET])
1956 return;
1957
1958 usb_del_gadget_udc(&ci->gadget);
1959
1960 destroy_eps(ci);
1961
1962 dma_pool_destroy(ci->td_pool);
1963 dma_pool_destroy(ci->qh_pool);
1964 }
1965
1966 static int udc_id_switch_for_device(struct ci_hdrc *ci)
1967 {
1968 if (ci->is_otg)
1969 /* Clear and enable BSV irq */
1970 hw_write_otgsc(ci, OTGSC_BSVIS | OTGSC_BSVIE,
1971 OTGSC_BSVIS | OTGSC_BSVIE);
1972
1973 return 0;
1974 }
1975
1976 static void udc_id_switch_for_host(struct ci_hdrc *ci)
1977 {
1978 /*
1979 * host doesn't care B_SESSION_VALID event
1980 * so clear and disbale BSV irq
1981 */
1982 if (ci->is_otg)
1983 hw_write_otgsc(ci, OTGSC_BSVIE | OTGSC_BSVIS, OTGSC_BSVIS);
1984 }
1985
1986 /**
1987 * ci_hdrc_gadget_init - initialize device related bits
1988 * ci: the controller
1989 *
1990 * This function initializes the gadget, if the device is "device capable".
1991 */
1992 int ci_hdrc_gadget_init(struct ci_hdrc *ci)
1993 {
1994 struct ci_role_driver *rdrv;
1995
1996 if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DC))
1997 return -ENXIO;
1998
1999 rdrv = devm_kzalloc(ci->dev, sizeof(struct ci_role_driver), GFP_KERNEL);
2000 if (!rdrv)
2001 return -ENOMEM;
2002
2003 rdrv->start = udc_id_switch_for_device;
2004 rdrv->stop = udc_id_switch_for_host;
2005 rdrv->irq = udc_irq;
2006 rdrv->name = "gadget";
2007 ci->roles[CI_ROLE_GADGET] = rdrv;
2008
2009 return udc_start(ci);
2010 }
This page took 0.077707 seconds and 5 git commands to generate.