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)
69 case EP0_STATUS_PHASE:
70 return "Status Phase";
76 static int dwc3_ep0_start_trans(struct dwc3 *dwc, u8 epnum, dma_addr_t buf_dma,
79 struct dwc3_gadget_ep_cmd_params params;
80 struct dwc3_trb_hw *trb_hw;
86 dep = dwc->eps[epnum];
87 if (dep->flags & DWC3_EP_BUSY) {
88 dev_vdbg(dwc->dev, "%s: still busy\n", dep->name);
92 trb_hw = dwc->ep0_trb;
93 memset(&trb, 0, sizeof(trb));
104 dwc3_trb_to_hw(&trb, trb_hw);
106 memset(¶ms, 0, sizeof(params));
107 params.param0.depstrtxfer.transfer_desc_addr_high =
108 upper_32_bits(dwc->ep0_trb_addr);
109 params.param1.depstrtxfer.transfer_desc_addr_low =
110 lower_32_bits(dwc->ep0_trb_addr);
112 ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
113 DWC3_DEPCMD_STARTTRANSFER, ¶ms);
115 dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");
119 dep->flags |= DWC3_EP_BUSY;
120 dep->res_trans_idx = dwc3_gadget_ep_get_transfer_index(dwc,
123 dwc->ep0_next_event = DWC3_EP0_COMPLETE;
128 static int __dwc3_gadget_ep0_queue(struct dwc3_ep *dep,
129 struct dwc3_request *req)
133 req->request.actual = 0;
134 req->request.status = -EINPROGRESS;
135 req->epnum = dep->number;
137 list_add_tail(&req->list, &dep->request_list);
140 * Gadget driver might not be quick enough to queue a request
141 * before we get a Transfer Not Ready event on this endpoint.
143 * In that case, we will set DWC3_EP_PENDING_REQUEST. When that
144 * flag is set, it's telling us that as soon as Gadget queues the
145 * required request, we should kick the transfer here because the
146 * IRQ we were waiting for is long gone.
148 if (dep->flags & DWC3_EP_PENDING_REQUEST) {
149 struct dwc3 *dwc = dep->dwc;
153 direction = !!(dep->flags & DWC3_EP0_DIR_IN);
155 if (dwc->ep0state == EP0_STATUS_PHASE) {
156 type = dwc->three_stage_setup
157 ? DWC3_TRBCTL_CONTROL_STATUS3
158 : DWC3_TRBCTL_CONTROL_STATUS2;
159 } else if (dwc->ep0state == EP0_DATA_PHASE) {
160 type = DWC3_TRBCTL_CONTROL_DATA;
162 /* should never happen */
167 ret = dwc3_ep0_start_trans(dwc, direction,
168 req->request.dma, req->request.length, type);
169 dep->flags &= ~(DWC3_EP_PENDING_REQUEST |
176 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
179 struct dwc3_request *req = to_dwc3_request(request);
180 struct dwc3_ep *dep = to_dwc3_ep(ep);
181 struct dwc3 *dwc = dep->dwc;
187 spin_lock_irqsave(&dwc->lock, flags);
189 dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",
195 /* we share one TRB for ep0/1 */
196 if (!list_empty(&dwc->eps[0]->request_list) ||
197 !list_empty(&dwc->eps[1]->request_list) ||
198 dwc->ep0_status_pending) {
203 dev_vdbg(dwc->dev, "queueing request %p to %s length %d, state '%s'\n",
204 request, dep->name, request->length,
205 dwc3_ep0_state_string(dwc->ep0state));
207 ret = __dwc3_gadget_ep0_queue(dep, req);
210 spin_unlock_irqrestore(&dwc->lock, flags);
215 static void dwc3_ep0_stall_and_restart(struct dwc3 *dwc)
217 struct dwc3_ep *dep = dwc->eps[0];
219 /* stall is always issued on EP0 */
220 __dwc3_gadget_ep_set_halt(dwc->eps[0], 1);
221 dwc->eps[0]->flags = DWC3_EP_ENABLED;
223 if (!list_empty(&dep->request_list)) {
224 struct dwc3_request *req;
226 req = next_request(&dep->request_list);
227 dwc3_gadget_giveback(dep, req, -ECONNRESET);
230 dwc->ep0state = EP0_SETUP_PHASE;
231 dwc3_ep0_out_start(dwc);
234 void dwc3_ep0_out_start(struct dwc3 *dwc)
238 ret = dwc3_ep0_start_trans(dwc, 0, dwc->ctrl_req_addr, 8,
239 DWC3_TRBCTL_CONTROL_SETUP);
243 static struct dwc3_ep *dwc3_wIndex_to_dep(struct dwc3 *dwc, __le16 wIndex_le)
246 u32 windex = le16_to_cpu(wIndex_le);
249 epnum = (windex & USB_ENDPOINT_NUMBER_MASK) << 1;
250 if ((windex & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN)
253 dep = dwc->eps[epnum];
254 if (dep->flags & DWC3_EP_ENABLED)
260 static void dwc3_ep0_send_status_response(struct dwc3 *dwc)
262 dwc3_ep0_start_trans(dwc, 1, dwc->setup_buf_addr,
263 dwc->ep0_usb_req.length,
264 DWC3_TRBCTL_CONTROL_DATA);
270 static int dwc3_ep0_handle_status(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
275 __le16 *response_pkt;
277 recip = ctrl->bRequestType & USB_RECIP_MASK;
279 case USB_RECIP_DEVICE:
281 * We are self-powered. U1/U2/LTM will be set later
282 * once we handle this states. RemoteWakeup is 0 on SS
284 usb_status |= dwc->is_selfpowered << USB_DEVICE_SELF_POWERED;
287 case USB_RECIP_INTERFACE:
289 * Function Remote Wake Capable D0
290 * Function Remote Wakeup D1
294 case USB_RECIP_ENDPOINT:
295 dep = dwc3_wIndex_to_dep(dwc, ctrl->wIndex);
299 if (dep->flags & DWC3_EP_STALL)
300 usb_status = 1 << USB_ENDPOINT_HALT;
306 response_pkt = (__le16 *) dwc->setup_buf;
307 *response_pkt = cpu_to_le16(usb_status);
308 dwc->ep0_usb_req.length = sizeof(*response_pkt);
309 dwc->ep0_status_pending = 1;
314 static int dwc3_ep0_handle_feature(struct dwc3 *dwc,
315 struct usb_ctrlrequest *ctrl, int set)
325 wValue = le16_to_cpu(ctrl->wValue);
326 wIndex = le16_to_cpu(ctrl->wIndex);
327 recip = ctrl->bRequestType & USB_RECIP_MASK;
329 case USB_RECIP_DEVICE:
332 * 9.4.1 says only only for SS, in AddressState only for
333 * default control pipe
336 case USB_DEVICE_U1_ENABLE:
337 case USB_DEVICE_U2_ENABLE:
338 case USB_DEVICE_LTM_ENABLE:
339 if (dwc->dev_state != DWC3_CONFIGURED_STATE)
341 if (dwc->speed != DWC3_DSTS_SUPERSPEED)
345 /* XXX add U[12] & LTM */
347 case USB_DEVICE_REMOTE_WAKEUP:
349 case USB_DEVICE_U1_ENABLE:
351 case USB_DEVICE_U2_ENABLE:
353 case USB_DEVICE_LTM_ENABLE:
356 case USB_DEVICE_TEST_MODE:
357 if ((wIndex & 0xff) != 0)
363 reg = dwc3_readl(dwc->regs, DWC3_DCTL);
364 reg &= ~DWC3_DCTL_TSTCTRL_MASK;
377 dwc3_writel(dwc->regs, DWC3_DCTL, reg);
384 case USB_RECIP_INTERFACE:
386 case USB_INTRF_FUNC_SUSPEND:
387 if (wIndex & USB_INTRF_FUNC_SUSPEND_LP)
388 /* XXX enable Low power suspend */
390 if (wIndex & USB_INTRF_FUNC_SUSPEND_RW)
391 /* XXX enable remote wakeup */
399 case USB_RECIP_ENDPOINT:
401 case USB_ENDPOINT_HALT:
403 dep = dwc3_wIndex_to_dep(dwc, ctrl->wIndex);
406 ret = __dwc3_gadget_ep_set_halt(dep, set);
422 static int dwc3_ep0_set_address(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
428 addr = le16_to_cpu(ctrl->wValue);
432 switch (dwc->dev_state) {
433 case DWC3_DEFAULT_STATE:
434 case DWC3_ADDRESS_STATE:
436 * Not sure if we should program DevAddr now or later
438 reg = dwc3_readl(dwc->regs, DWC3_DCFG);
439 reg &= ~(DWC3_DCFG_DEVADDR_MASK);
440 reg |= DWC3_DCFG_DEVADDR(addr);
441 dwc3_writel(dwc->regs, DWC3_DCFG, reg);
444 dwc->dev_state = DWC3_ADDRESS_STATE;
446 dwc->dev_state = DWC3_DEFAULT_STATE;
449 case DWC3_CONFIGURED_STATE:
457 static int dwc3_ep0_delegate_req(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
461 spin_unlock(&dwc->lock);
462 ret = dwc->gadget_driver->setup(&dwc->gadget, ctrl);
463 spin_lock(&dwc->lock);
467 static int dwc3_ep0_set_config(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
472 cfg = le16_to_cpu(ctrl->wValue);
474 switch (dwc->dev_state) {
475 case DWC3_DEFAULT_STATE:
479 case DWC3_ADDRESS_STATE:
480 ret = dwc3_ep0_delegate_req(dwc, ctrl);
481 /* if the cfg matches and the cfg is non zero */
483 dwc->dev_state = DWC3_CONFIGURED_STATE;
486 case DWC3_CONFIGURED_STATE:
487 ret = dwc3_ep0_delegate_req(dwc, ctrl);
489 dwc->dev_state = DWC3_ADDRESS_STATE;
495 static int dwc3_ep0_std_request(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
499 switch (ctrl->bRequest) {
500 case USB_REQ_GET_STATUS:
501 dev_vdbg(dwc->dev, "USB_REQ_GET_STATUS\n");
502 ret = dwc3_ep0_handle_status(dwc, ctrl);
504 case USB_REQ_CLEAR_FEATURE:
505 dev_vdbg(dwc->dev, "USB_REQ_CLEAR_FEATURE\n");
506 ret = dwc3_ep0_handle_feature(dwc, ctrl, 0);
508 case USB_REQ_SET_FEATURE:
509 dev_vdbg(dwc->dev, "USB_REQ_SET_FEATURE\n");
510 ret = dwc3_ep0_handle_feature(dwc, ctrl, 1);
512 case USB_REQ_SET_ADDRESS:
513 dev_vdbg(dwc->dev, "USB_REQ_SET_ADDRESS\n");
514 ret = dwc3_ep0_set_address(dwc, ctrl);
516 case USB_REQ_SET_CONFIGURATION:
517 dev_vdbg(dwc->dev, "USB_REQ_SET_CONFIGURATION\n");
518 ret = dwc3_ep0_set_config(dwc, ctrl);
521 dev_vdbg(dwc->dev, "Forwarding to gadget driver\n");
522 ret = dwc3_ep0_delegate_req(dwc, ctrl);
529 static void dwc3_ep0_inspect_setup(struct dwc3 *dwc,
530 const struct dwc3_event_depevt *event)
532 struct usb_ctrlrequest *ctrl = dwc->ctrl_req;
536 if (!dwc->gadget_driver)
539 len = le16_to_cpu(ctrl->wLength);
541 dwc->three_stage_setup = 0;
542 dwc->ep0_next_event = DWC3_EP0_NRDY_STATUS;
544 dwc->three_stage_setup = 1;
545 dwc->ep0_next_event = DWC3_EP0_NRDY_DATA;
548 dwc->ep0_expect_in = !!(ctrl->bRequestType & USB_DIR_IN);
550 if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD)
551 ret = dwc3_ep0_std_request(dwc, ctrl);
553 ret = dwc3_ep0_delegate_req(dwc, ctrl);
559 dwc3_ep0_stall_and_restart(dwc);
562 static void dwc3_ep0_complete_data(struct dwc3 *dwc,
563 const struct dwc3_event_depevt *event)
565 struct dwc3_request *r = NULL;
566 struct usb_request *ur;
572 epnum = event->endpoint_number;
573 dep = dwc->eps[epnum];
575 dwc->ep0_next_event = DWC3_EP0_NRDY_STATUS;
577 if (!dwc->ep0_status_pending) {
578 r = next_request(&dwc->eps[0]->request_list);
581 ur = &dwc->ep0_usb_req;
582 dwc->ep0_status_pending = 0;
585 dwc3_trb_to_nat(dwc->ep0_trb, &trb);
587 if (dwc->ep0_bounced) {
588 struct dwc3_ep *ep0 = dwc->eps[0];
590 transferred = min_t(u32, ur->length,
591 ep0->endpoint.maxpacket - trb.length);
592 memcpy(ur->buf, dwc->ep0_bounce, transferred);
593 dwc->ep0_bounced = false;
595 transferred = ur->length - trb.length;
596 ur->actual += transferred;
599 if ((epnum & 1) && ur->actual < ur->length) {
600 /* for some reason we did not get everything out */
602 dwc3_ep0_stall_and_restart(dwc);
603 dwc3_gadget_giveback(dep, r, -ECONNRESET);
606 * handle the case where we have to send a zero packet. This
607 * seems to be case when req.length > maxpacket. Could it be?
610 dwc3_gadget_giveback(dep, r, 0);
614 static void dwc3_ep0_complete_req(struct dwc3 *dwc,
615 const struct dwc3_event_depevt *event)
617 struct dwc3_request *r;
622 if (!list_empty(&dep->request_list)) {
623 r = next_request(&dep->request_list);
625 dwc3_gadget_giveback(dep, r, 0);
628 dwc->ep0state = EP0_SETUP_PHASE;
629 dwc3_ep0_out_start(dwc);
632 static void dwc3_ep0_xfer_complete(struct dwc3 *dwc,
633 const struct dwc3_event_depevt *event)
635 struct dwc3_ep *dep = dwc->eps[event->endpoint_number];
637 dep->flags &= ~DWC3_EP_BUSY;
639 switch (dwc->ep0state) {
640 case EP0_SETUP_PHASE:
641 dev_vdbg(dwc->dev, "Inspecting Setup Bytes\n");
642 dwc3_ep0_inspect_setup(dwc, event);
646 dev_vdbg(dwc->dev, "Data Phase\n");
647 dwc3_ep0_complete_data(dwc, event);
650 case EP0_STATUS_PHASE:
651 dev_vdbg(dwc->dev, "Status Phase\n");
652 dwc3_ep0_complete_req(dwc, event);
655 WARN(true, "UNKNOWN ep0state %d\n", dwc->ep0state);
659 static void dwc3_ep0_do_control_setup(struct dwc3 *dwc,
660 const struct dwc3_event_depevt *event)
662 dwc->ep0state = EP0_SETUP_PHASE;
663 dwc3_ep0_out_start(dwc);
666 static void dwc3_ep0_do_control_data(struct dwc3 *dwc,
667 const struct dwc3_event_depevt *event)
670 struct dwc3_request *req;
674 dwc->ep0state = EP0_DATA_PHASE;
676 if (dwc->ep0_status_pending) {
677 dwc3_ep0_send_status_response(dwc);
681 if (list_empty(&dep->request_list)) {
682 dev_vdbg(dwc->dev, "pending request for EP0 Data phase\n");
683 dep->flags |= DWC3_EP_PENDING_REQUEST;
685 if (event->endpoint_number)
686 dep->flags |= DWC3_EP0_DIR_IN;
690 req = next_request(&dep->request_list);
691 req->direction = !!event->endpoint_number;
693 dwc->ep0state = EP0_DATA_PHASE;
694 if (req->request.length == 0) {
695 ret = dwc3_ep0_start_trans(dwc, event->endpoint_number,
696 dwc->ctrl_req_addr, 0,
697 DWC3_TRBCTL_CONTROL_DATA);
698 } else if ((req->request.length % dep->endpoint.maxpacket)
699 && (event->endpoint_number == 0)) {
700 dwc3_map_buffer_to_dma(req);
702 WARN_ON(req->request.length > dep->endpoint.maxpacket);
704 dwc->ep0_bounced = true;
707 * REVISIT in case request length is bigger than EP0
708 * wMaxPacketSize, we will need two chained TRBs to handle
711 ret = dwc3_ep0_start_trans(dwc, event->endpoint_number,
712 dwc->ep0_bounce_addr, dep->endpoint.maxpacket,
713 DWC3_TRBCTL_CONTROL_DATA);
715 dwc3_map_buffer_to_dma(req);
717 ret = dwc3_ep0_start_trans(dwc, event->endpoint_number,
718 req->request.dma, req->request.length,
719 DWC3_TRBCTL_CONTROL_DATA);
725 static void dwc3_ep0_do_control_status(struct dwc3 *dwc,
726 const struct dwc3_event_depevt *event)
731 dwc->ep0state = EP0_STATUS_PHASE;
733 type = dwc->three_stage_setup ? DWC3_TRBCTL_CONTROL_STATUS3
734 : DWC3_TRBCTL_CONTROL_STATUS2;
736 ret = dwc3_ep0_start_trans(dwc, event->endpoint_number,
737 dwc->ctrl_req_addr, 0, type);
742 static void dwc3_ep0_xfernotready(struct dwc3 *dwc,
743 const struct dwc3_event_depevt *event)
745 switch (event->status) {
746 case DEPEVT_STATUS_CONTROL_SETUP:
747 dev_vdbg(dwc->dev, "Control Setup\n");
748 dwc3_ep0_do_control_setup(dwc, event);
751 case DEPEVT_STATUS_CONTROL_DATA:
752 dev_vdbg(dwc->dev, "Control Data\n");
754 if (dwc->ep0_next_event != DWC3_EP0_NRDY_DATA) {
755 dev_vdbg(dwc->dev, "Expected %d got %d\n",
756 DEPEVT_STATUS_CONTROL_DATA,
759 dwc3_ep0_stall_and_restart(dwc);
764 * One of the possible error cases is when Host _does_
765 * request for Data Phase, but it does so on the wrong
768 * Here, we already know ep0_next_event is DATA (see above),
769 * so we only need to check for direction.
771 if (dwc->ep0_expect_in != event->endpoint_number) {
772 dev_vdbg(dwc->dev, "Wrong direction for Data phase\n");
773 dwc3_ep0_stall_and_restart(dwc);
777 dwc3_ep0_do_control_data(dwc, event);
780 case DEPEVT_STATUS_CONTROL_STATUS:
781 dev_vdbg(dwc->dev, "Control Status\n");
783 if (dwc->ep0_next_event != DWC3_EP0_NRDY_STATUS) {
784 dev_vdbg(dwc->dev, "Expected %d got %d\n",
785 DEPEVT_STATUS_CONTROL_STATUS,
788 dwc3_ep0_stall_and_restart(dwc);
791 dwc3_ep0_do_control_status(dwc, event);
795 void dwc3_ep0_interrupt(struct dwc3 *dwc,
796 const const struct dwc3_event_depevt *event)
798 u8 epnum = event->endpoint_number;
800 dev_dbg(dwc->dev, "%s while ep%d%s in state '%s'\n",
801 dwc3_ep_event_string(event->endpoint_event),
802 epnum, (epnum & 1) ? "in" : "out",
803 dwc3_ep0_state_string(dwc->ep0state));
805 switch (event->endpoint_event) {
806 case DWC3_DEPEVT_XFERCOMPLETE:
807 dwc3_ep0_xfer_complete(dwc, event);
810 case DWC3_DEPEVT_XFERNOTREADY:
811 dwc3_ep0_xfernotready(dwc, event);
814 case DWC3_DEPEVT_XFERINPROGRESS:
815 case DWC3_DEPEVT_RXTXFIFOEVT:
816 case DWC3_DEPEVT_STREAMEVT:
817 case DWC3_DEPEVT_EPCMDCMPLT: