2 * ep0.c - DesignWare USB3 DRD Controller Endpoint 0 Handling
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions, and the following disclaimer,
15 * without modification.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. The names of the above-listed copyright holders may not be used
20 * to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * ALTERNATIVELY, this software may be distributed under the terms of the
24 * GNU General Public License ("GPL") version 2, as published by the Free
25 * Software Foundation.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <linux/kernel.h>
41 #include <linux/slab.h>
42 #include <linux/spinlock.h>
43 #include <linux/platform_device.h>
44 #include <linux/pm_runtime.h>
45 #include <linux/interrupt.h>
47 #include <linux/list.h>
48 #include <linux/dma-mapping.h>
50 #include <linux/usb/ch9.h>
51 #include <linux/usb/gadget.h>
57 static void dwc3_ep0_inspect_setup(struct dwc3
*dwc
,
58 const struct dwc3_event_depevt
*event
);
60 static const char *dwc3_ep0_state_string(enum dwc3_ep0_state state
)
67 case EP0_IN_DATA_PHASE
:
68 return "IN Data Phase";
69 case EP0_OUT_DATA_PHASE
:
70 return "OUT Data Phase";
71 case EP0_IN_WAIT_GADGET
:
72 return "IN Wait Gadget";
73 case EP0_OUT_WAIT_GADGET
:
74 return "OUT Wait Gadget";
75 case EP0_IN_WAIT_NRDY
:
76 return "IN Wait NRDY";
77 case EP0_OUT_WAIT_NRDY
:
78 return "OUT Wait NRDY";
79 case EP0_IN_STATUS_PHASE
:
80 return "IN Status Phase";
81 case EP0_OUT_STATUS_PHASE
:
82 return "OUT Status Phase";
90 static int dwc3_ep0_start_trans(struct dwc3
*dwc
, u8 epnum
, dma_addr_t buf_dma
,
93 struct dwc3_gadget_ep_cmd_params params
;
94 struct dwc3_trb_hw
*trb_hw
;
100 dep
= dwc
->eps
[epnum
];
102 trb_hw
= dwc
->ep0_trb
;
103 memset(&trb
, 0, sizeof(trb
));
105 switch (dwc
->ep0state
) {
107 trb
.trbctl
= DWC3_TRBCTL_CONTROL_SETUP
;
110 case EP0_IN_WAIT_NRDY
:
111 case EP0_OUT_WAIT_NRDY
:
112 case EP0_IN_STATUS_PHASE
:
113 case EP0_OUT_STATUS_PHASE
:
114 if (dwc
->three_stage_setup
)
115 trb
.trbctl
= DWC3_TRBCTL_CONTROL_STATUS3
;
117 trb
.trbctl
= DWC3_TRBCTL_CONTROL_STATUS2
;
119 if (dwc
->ep0state
== EP0_IN_WAIT_NRDY
)
120 dwc
->ep0state
= EP0_IN_STATUS_PHASE
;
121 else if (dwc
->ep0state
== EP0_OUT_WAIT_NRDY
)
122 dwc
->ep0state
= EP0_OUT_STATUS_PHASE
;
125 case EP0_IN_WAIT_GADGET
:
126 dwc
->ep0state
= EP0_IN_WAIT_NRDY
;
130 case EP0_OUT_WAIT_GADGET
:
131 dwc
->ep0state
= EP0_OUT_WAIT_NRDY
;
136 case EP0_IN_DATA_PHASE
:
137 case EP0_OUT_DATA_PHASE
:
138 trb
.trbctl
= DWC3_TRBCTL_CONTROL_DATA
;
142 dev_err(dwc
->dev
, "%s() can't in state %d\n", __func__
,
155 dwc3_trb_to_hw(&trb
, trb_hw
);
157 memset(¶ms
, 0, sizeof(params
));
158 params
.param0
.depstrtxfer
.transfer_desc_addr_high
=
159 upper_32_bits(dwc
->ep0_trb_addr
);
160 params
.param1
.depstrtxfer
.transfer_desc_addr_low
=
161 lower_32_bits(dwc
->ep0_trb_addr
);
163 ret
= dwc3_send_gadget_ep_cmd(dwc
, dep
->number
,
164 DWC3_DEPCMD_STARTTRANSFER
, ¶ms
);
166 dev_dbg(dwc
->dev
, "failed to send STARTTRANSFER command\n");
170 dep
->res_trans_idx
= dwc3_gadget_ep_get_transfer_index(dwc
,
176 static int __dwc3_gadget_ep0_queue(struct dwc3_ep
*dep
,
177 struct dwc3_request
*req
)
179 struct dwc3
*dwc
= dep
->dwc
;
182 req
->request
.actual
= 0;
183 req
->request
.status
= -EINPROGRESS
;
184 req
->direction
= dep
->direction
;
185 req
->epnum
= dep
->number
;
187 list_add_tail(&req
->list
, &dep
->request_list
);
188 if (req
->request
.length
== 0) {
189 ret
= dwc3_ep0_start_trans(dwc
, dep
->number
,
190 dwc
->ctrl_req_addr
, 0);
191 } else if ((req
->request
.length
% dep
->endpoint
.maxpacket
)
192 && (dep
->number
== 0)) {
193 dwc
->ep0_bounced
= true;
195 WARN_ON(req
->request
.length
> dep
->endpoint
.maxpacket
);
198 * REVISIT in case request length is bigger than EP0
199 * wMaxPacketSize, we will need two chained TRBs to handle
202 ret
= dwc3_ep0_start_trans(dwc
, dep
->number
,
203 dwc
->ep0_bounce_addr
, dep
->endpoint
.maxpacket
);
205 dwc3_map_buffer_to_dma(req
);
207 ret
= dwc3_ep0_start_trans(dwc
, dep
->number
,
208 req
->request
.dma
, req
->request
.length
);
212 list_del(&req
->list
);
213 dwc3_unmap_buffer_from_dma(req
);
219 int dwc3_gadget_ep0_queue(struct usb_ep
*ep
, struct usb_request
*request
,
222 struct dwc3_request
*req
= to_dwc3_request(request
);
223 struct dwc3_ep
*dep
= to_dwc3_ep(ep
);
224 struct dwc3
*dwc
= dep
->dwc
;
230 switch (dwc
->ep0state
) {
231 case EP0_IN_DATA_PHASE
:
232 case EP0_IN_WAIT_GADGET
:
233 case EP0_IN_WAIT_NRDY
:
234 case EP0_IN_STATUS_PHASE
:
238 case EP0_OUT_DATA_PHASE
:
239 case EP0_OUT_WAIT_GADGET
:
240 case EP0_OUT_WAIT_NRDY
:
241 case EP0_OUT_STATUS_PHASE
:
248 spin_lock_irqsave(&dwc
->lock
, flags
);
250 dev_dbg(dwc
->dev
, "trying to queue request %p to disabled %s\n",
256 /* we share one TRB for ep0/1 */
257 if (!list_empty(&dwc
->eps
[0]->request_list
) ||
258 !list_empty(&dwc
->eps
[1]->request_list
) ||
259 dwc
->ep0_status_pending
) {
264 dev_vdbg(dwc
->dev
, "queueing request %p to %s length %d, state '%s'\n",
265 request
, dep
->name
, request
->length
,
266 dwc3_ep0_state_string(dwc
->ep0state
));
268 ret
= __dwc3_gadget_ep0_queue(dep
, req
);
271 spin_unlock_irqrestore(&dwc
->lock
, flags
);
276 static void dwc3_ep0_stall_and_restart(struct dwc3
*dwc
)
278 /* stall is always issued on EP0 */
279 __dwc3_gadget_ep_set_halt(dwc
->eps
[0], 1);
280 dwc
->eps
[0]->flags
&= ~DWC3_EP_STALL
;
281 dwc
->ep0state
= EP0_IDLE
;
282 dwc3_ep0_out_start(dwc
);
285 void dwc3_ep0_out_start(struct dwc3
*dwc
)
292 ret
= dwc3_ep0_start_trans(dwc
, 0, dwc
->ctrl_req_addr
, 8);
297 * Send a zero length packet for the status phase of the control transfer
299 static void dwc3_ep0_do_setup_status(struct dwc3
*dwc
,
300 const struct dwc3_event_depevt
*event
)
306 epnum
= event
->endpoint_number
;
307 dep
= dwc
->eps
[epnum
];
310 dwc
->ep0state
= EP0_IN_STATUS_PHASE
;
312 dwc
->ep0state
= EP0_OUT_STATUS_PHASE
;
315 * Not sure Why I need a buffer for a zero transfer. Maybe the
316 * HW reacts strange on a NULL pointer
318 ret
= dwc3_ep0_start_trans(dwc
, epnum
, dwc
->ctrl_req_addr
, 0);
320 dev_dbg(dwc
->dev
, "failed to start transfer, stalling\n");
321 dwc3_ep0_stall_and_restart(dwc
);
325 static struct dwc3_ep
*dwc3_wIndex_to_dep(struct dwc3
*dwc
, __le16 wIndex_le
)
328 u32 windex
= le16_to_cpu(wIndex_le
);
331 epnum
= (windex
& USB_ENDPOINT_NUMBER_MASK
) << 1;
332 if ((windex
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
)
335 dep
= dwc
->eps
[epnum
];
336 if (dep
->flags
& DWC3_EP_ENABLED
)
342 static void dwc3_ep0_send_status_response(struct dwc3
*dwc
)
346 if (dwc
->ep0state
== EP0_IN_DATA_PHASE
)
351 dwc3_ep0_start_trans(dwc
, epnum
, dwc
->ctrl_req_addr
,
352 dwc
->ep0_usb_req
.length
);
353 dwc
->ep0_status_pending
= 1;
359 static int dwc3_ep0_handle_status(struct dwc3
*dwc
, struct usb_ctrlrequest
*ctrl
)
364 __le16
*response_pkt
;
366 recip
= ctrl
->bRequestType
& USB_RECIP_MASK
;
368 case USB_RECIP_DEVICE
:
370 * We are self-powered. U1/U2/LTM will be set later
371 * once we handle this states. RemoteWakeup is 0 on SS
373 usb_status
|= dwc
->is_selfpowered
<< USB_DEVICE_SELF_POWERED
;
376 case USB_RECIP_INTERFACE
:
378 * Function Remote Wake Capable D0
379 * Function Remote Wakeup D1
383 case USB_RECIP_ENDPOINT
:
384 dep
= dwc3_wIndex_to_dep(dwc
, ctrl
->wIndex
);
388 if (dep
->flags
& DWC3_EP_STALL
)
389 usb_status
= 1 << USB_ENDPOINT_HALT
;
395 response_pkt
= (__le16
*) dwc
->setup_buf
;
396 *response_pkt
= cpu_to_le16(usb_status
);
397 dwc
->ep0_usb_req
.length
= sizeof(*response_pkt
);
398 dwc3_ep0_send_status_response(dwc
);
403 static int dwc3_ep0_handle_feature(struct dwc3
*dwc
,
404 struct usb_ctrlrequest
*ctrl
, int set
)
414 wValue
= le16_to_cpu(ctrl
->wValue
);
415 wIndex
= le16_to_cpu(ctrl
->wIndex
);
416 recip
= ctrl
->bRequestType
& USB_RECIP_MASK
;
418 case USB_RECIP_DEVICE
:
421 * 9.4.1 says only only for SS, in AddressState only for
422 * default control pipe
425 case USB_DEVICE_U1_ENABLE
:
426 case USB_DEVICE_U2_ENABLE
:
427 case USB_DEVICE_LTM_ENABLE
:
428 if (dwc
->dev_state
!= DWC3_CONFIGURED_STATE
)
430 if (dwc
->speed
!= DWC3_DSTS_SUPERSPEED
)
434 /* XXX add U[12] & LTM */
436 case USB_DEVICE_REMOTE_WAKEUP
:
438 case USB_DEVICE_U1_ENABLE
:
440 case USB_DEVICE_U2_ENABLE
:
442 case USB_DEVICE_LTM_ENABLE
:
445 case USB_DEVICE_TEST_MODE
:
446 if ((wIndex
& 0xff) != 0)
452 reg
= dwc3_readl(dwc
->regs
, DWC3_DCTL
);
453 reg
&= ~DWC3_DCTL_TSTCTRL_MASK
;
466 dwc3_writel(dwc
->regs
, DWC3_DCTL
, reg
);
473 case USB_RECIP_INTERFACE
:
475 case USB_INTRF_FUNC_SUSPEND
:
476 if (wIndex
& USB_INTRF_FUNC_SUSPEND_LP
)
477 /* XXX enable Low power suspend */
479 if (wIndex
& USB_INTRF_FUNC_SUSPEND_RW
)
480 /* XXX enable remote wakeup */
488 case USB_RECIP_ENDPOINT
:
490 case USB_ENDPOINT_HALT
:
492 dep
= dwc3_wIndex_to_dep(dwc
, ctrl
->wIndex
);
495 ret
= __dwc3_gadget_ep_set_halt(dep
, set
);
508 dwc
->ep0state
= EP0_IN_WAIT_NRDY
;
513 static int dwc3_ep0_set_address(struct dwc3
*dwc
, struct usb_ctrlrequest
*ctrl
)
519 addr
= le16_to_cpu(ctrl
->wValue
);
523 switch (dwc
->dev_state
) {
524 case DWC3_DEFAULT_STATE
:
525 case DWC3_ADDRESS_STATE
:
527 * Not sure if we should program DevAddr now or later
529 reg
= dwc3_readl(dwc
->regs
, DWC3_DCFG
);
530 reg
&= ~(DWC3_DCFG_DEVADDR_MASK
);
531 reg
|= DWC3_DCFG_DEVADDR(addr
);
532 dwc3_writel(dwc
->regs
, DWC3_DCFG
, reg
);
535 dwc
->dev_state
= DWC3_ADDRESS_STATE
;
537 dwc
->dev_state
= DWC3_DEFAULT_STATE
;
540 case DWC3_CONFIGURED_STATE
:
544 dwc
->ep0state
= EP0_IN_WAIT_NRDY
;
548 static int dwc3_ep0_delegate_req(struct dwc3
*dwc
, struct usb_ctrlrequest
*ctrl
)
552 spin_unlock(&dwc
->lock
);
553 ret
= dwc
->gadget_driver
->setup(&dwc
->gadget
, ctrl
);
554 spin_lock(&dwc
->lock
);
558 static int dwc3_ep0_set_config(struct dwc3
*dwc
, struct usb_ctrlrequest
*ctrl
)
563 cfg
= le16_to_cpu(ctrl
->wValue
);
565 switch (dwc
->dev_state
) {
566 case DWC3_DEFAULT_STATE
:
570 case DWC3_ADDRESS_STATE
:
571 ret
= dwc3_ep0_delegate_req(dwc
, ctrl
);
572 /* if the cfg matches and the cfg is non zero */
574 dwc
->dev_state
= DWC3_CONFIGURED_STATE
;
577 case DWC3_CONFIGURED_STATE
:
578 ret
= dwc3_ep0_delegate_req(dwc
, ctrl
);
580 dwc
->dev_state
= DWC3_ADDRESS_STATE
;
586 static int dwc3_ep0_std_request(struct dwc3
*dwc
, struct usb_ctrlrequest
*ctrl
)
590 switch (ctrl
->bRequest
) {
591 case USB_REQ_GET_STATUS
:
592 dev_vdbg(dwc
->dev
, "USB_REQ_GET_STATUS\n");
593 ret
= dwc3_ep0_handle_status(dwc
, ctrl
);
595 case USB_REQ_CLEAR_FEATURE
:
596 dev_vdbg(dwc
->dev
, "USB_REQ_CLEAR_FEATURE\n");
597 ret
= dwc3_ep0_handle_feature(dwc
, ctrl
, 0);
599 case USB_REQ_SET_FEATURE
:
600 dev_vdbg(dwc
->dev
, "USB_REQ_SET_FEATURE\n");
601 ret
= dwc3_ep0_handle_feature(dwc
, ctrl
, 1);
603 case USB_REQ_SET_ADDRESS
:
604 dev_vdbg(dwc
->dev
, "USB_REQ_SET_ADDRESS\n");
605 ret
= dwc3_ep0_set_address(dwc
, ctrl
);
607 case USB_REQ_SET_CONFIGURATION
:
608 dev_vdbg(dwc
->dev
, "USB_REQ_SET_CONFIGURATION\n");
609 ret
= dwc3_ep0_set_config(dwc
, ctrl
);
612 dev_vdbg(dwc
->dev
, "Forwarding to gadget driver\n");
613 ret
= dwc3_ep0_delegate_req(dwc
, ctrl
);
620 static void dwc3_ep0_inspect_setup(struct dwc3
*dwc
,
621 const struct dwc3_event_depevt
*event
)
623 struct usb_ctrlrequest
*ctrl
= dwc
->ctrl_req
;
627 if (!dwc
->gadget_driver
)
630 len
= le16_to_cpu(ctrl
->wLength
);
632 dwc
->ep0state
= EP0_IN_WAIT_GADGET
;
633 dwc
->three_stage_setup
= 0;
635 dwc
->three_stage_setup
= 1;
636 if (ctrl
->bRequestType
& USB_DIR_IN
)
637 dwc
->ep0state
= EP0_IN_DATA_PHASE
;
639 dwc
->ep0state
= EP0_OUT_DATA_PHASE
;
642 if ((ctrl
->bRequestType
& USB_TYPE_MASK
) == USB_TYPE_STANDARD
)
643 ret
= dwc3_ep0_std_request(dwc
, ctrl
);
645 ret
= dwc3_ep0_delegate_req(dwc
, ctrl
);
651 dwc3_ep0_stall_and_restart(dwc
);
654 static void dwc3_ep0_complete_data(struct dwc3
*dwc
,
655 const struct dwc3_event_depevt
*event
)
657 struct dwc3_request
*r
= NULL
;
658 struct usb_request
*ur
;
664 epnum
= event
->endpoint_number
;
665 dep
= dwc
->eps
[epnum
];
667 if (!dwc
->ep0_status_pending
) {
668 r
= next_request(&dep
->request_list
);
671 ur
= &dwc
->ep0_usb_req
;
672 dwc
->ep0_status_pending
= 0;
675 dwc3_trb_to_nat(dwc
->ep0_trb
, &trb
);
677 if (dwc
->ep0_bounced
) {
678 struct dwc3_ep
*ep0
= dwc
->eps
[0];
680 transferred
= min(ur
->length
, dep
->endpoint
.maxpacket
- trb
.length
);
681 memcpy(ur
->buf
, dwc
->ep0_bounce
, transferred
);
682 dwc
->ep0_bounced
= false;
684 transferred
= ur
->length
- trb
.length
;
685 ur
->actual
+= transferred
;
688 if ((epnum
& 1) && ur
->actual
< ur
->length
) {
689 /* for some reason we did not get everything out */
691 dwc3_ep0_stall_and_restart(dwc
);
692 dwc3_gadget_giveback(dep
, r
, -ECONNRESET
);
695 * handle the case where we have to send a zero packet. This
696 * seems to be case when req.length > maxpacket. Could it be?
698 /* The transfer is complete, wait for HOST */
700 dwc
->ep0state
= EP0_IN_WAIT_NRDY
;
702 dwc
->ep0state
= EP0_OUT_WAIT_NRDY
;
705 dwc3_gadget_giveback(dep
, r
, 0);
709 static void dwc3_ep0_complete_req(struct dwc3
*dwc
,
710 const struct dwc3_event_depevt
*event
)
712 struct dwc3_request
*r
;
716 epnum
= event
->endpoint_number
;
717 dep
= dwc
->eps
[epnum
];
719 if (!list_empty(&dep
->request_list
)) {
720 r
= next_request(&dep
->request_list
);
722 dwc3_gadget_giveback(dep
, r
, 0);
725 dwc
->ep0state
= EP0_IDLE
;
726 dwc3_ep0_out_start(dwc
);
729 static void dwc3_ep0_xfer_complete(struct dwc3
*dwc
,
730 const struct dwc3_event_depevt
*event
)
732 switch (dwc
->ep0state
) {
734 dwc3_ep0_inspect_setup(dwc
, event
);
737 case EP0_IN_DATA_PHASE
:
738 case EP0_OUT_DATA_PHASE
:
739 dwc3_ep0_complete_data(dwc
, event
);
742 case EP0_IN_STATUS_PHASE
:
743 case EP0_OUT_STATUS_PHASE
:
744 dwc3_ep0_complete_req(dwc
, event
);
747 case EP0_IN_WAIT_NRDY
:
748 case EP0_OUT_WAIT_NRDY
:
749 case EP0_IN_WAIT_GADGET
:
750 case EP0_OUT_WAIT_GADGET
:
751 case EP0_UNCONNECTED
:
757 static void dwc3_ep0_xfernotready(struct dwc3
*dwc
,
758 const struct dwc3_event_depevt
*event
)
760 switch (dwc
->ep0state
) {
761 case EP0_IN_WAIT_GADGET
:
762 dwc
->ep0state
= EP0_IN_WAIT_NRDY
;
764 case EP0_OUT_WAIT_GADGET
:
765 dwc
->ep0state
= EP0_OUT_WAIT_NRDY
;
768 case EP0_IN_WAIT_NRDY
:
769 case EP0_OUT_WAIT_NRDY
:
770 dwc3_ep0_do_setup_status(dwc
, event
);
774 case EP0_IN_STATUS_PHASE
:
775 case EP0_OUT_STATUS_PHASE
:
776 case EP0_IN_DATA_PHASE
:
777 case EP0_OUT_DATA_PHASE
:
778 case EP0_UNCONNECTED
:
784 void dwc3_ep0_interrupt(struct dwc3
*dwc
,
785 const const struct dwc3_event_depevt
*event
)
787 u8 epnum
= event
->endpoint_number
;
789 dev_dbg(dwc
->dev
, "%s while ep%d%s in state '%s'\n",
790 dwc3_ep_event_string(event
->endpoint_event
),
791 epnum
, (epnum
& 1) ? "in" : "out",
792 dwc3_ep0_state_string(dwc
->ep0state
));
794 switch (event
->endpoint_event
) {
795 case DWC3_DEPEVT_XFERCOMPLETE
:
796 dwc3_ep0_xfer_complete(dwc
, event
);
799 case DWC3_DEPEVT_XFERNOTREADY
:
800 dwc3_ep0_xfernotready(dwc
, event
);
803 case DWC3_DEPEVT_XFERINPROGRESS
:
804 case DWC3_DEPEVT_RXTXFIFOEVT
:
805 case DWC3_DEPEVT_STREAMEVT
:
806 case DWC3_DEPEVT_EPCMDCMPLT
: