xref: /openbmc/linux/drivers/usb/dwc3/ep0.c (revision e23feb16)
1 /**
2  * ep0.c - DesignWare USB3 DRD Controller Endpoint 0 Handling
3  *
4  * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
5  *
6  * Authors: Felipe Balbi <balbi@ti.com>,
7  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2  of
11  * the License as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  */
18 
19 #include <linux/kernel.h>
20 #include <linux/slab.h>
21 #include <linux/spinlock.h>
22 #include <linux/platform_device.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/interrupt.h>
25 #include <linux/io.h>
26 #include <linux/list.h>
27 #include <linux/dma-mapping.h>
28 
29 #include <linux/usb/ch9.h>
30 #include <linux/usb/gadget.h>
31 #include <linux/usb/composite.h>
32 
33 #include "core.h"
34 #include "gadget.h"
35 #include "io.h"
36 
37 static void __dwc3_ep0_do_control_status(struct dwc3 *dwc, struct dwc3_ep *dep);
38 static void __dwc3_ep0_do_control_data(struct dwc3 *dwc,
39 		struct dwc3_ep *dep, struct dwc3_request *req);
40 
41 static const char *dwc3_ep0_state_string(enum dwc3_ep0_state state)
42 {
43 	switch (state) {
44 	case EP0_UNCONNECTED:
45 		return "Unconnected";
46 	case EP0_SETUP_PHASE:
47 		return "Setup Phase";
48 	case EP0_DATA_PHASE:
49 		return "Data Phase";
50 	case EP0_STATUS_PHASE:
51 		return "Status Phase";
52 	default:
53 		return "UNKNOWN";
54 	}
55 }
56 
57 static int dwc3_ep0_start_trans(struct dwc3 *dwc, u8 epnum, dma_addr_t buf_dma,
58 		u32 len, u32 type)
59 {
60 	struct dwc3_gadget_ep_cmd_params params;
61 	struct dwc3_trb			*trb;
62 	struct dwc3_ep			*dep;
63 
64 	int				ret;
65 
66 	dep = dwc->eps[epnum];
67 	if (dep->flags & DWC3_EP_BUSY) {
68 		dev_vdbg(dwc->dev, "%s: still busy\n", dep->name);
69 		return 0;
70 	}
71 
72 	trb = dwc->ep0_trb;
73 
74 	trb->bpl = lower_32_bits(buf_dma);
75 	trb->bph = upper_32_bits(buf_dma);
76 	trb->size = len;
77 	trb->ctrl = type;
78 
79 	trb->ctrl |= (DWC3_TRB_CTRL_HWO
80 			| DWC3_TRB_CTRL_LST
81 			| DWC3_TRB_CTRL_IOC
82 			| DWC3_TRB_CTRL_ISP_IMI);
83 
84 	memset(&params, 0, sizeof(params));
85 	params.param0 = upper_32_bits(dwc->ep0_trb_addr);
86 	params.param1 = lower_32_bits(dwc->ep0_trb_addr);
87 
88 	ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,
89 			DWC3_DEPCMD_STARTTRANSFER, &params);
90 	if (ret < 0) {
91 		dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");
92 		return ret;
93 	}
94 
95 	dep->flags |= DWC3_EP_BUSY;
96 	dep->resource_index = dwc3_gadget_ep_get_transfer_index(dwc,
97 			dep->number);
98 
99 	dwc->ep0_next_event = DWC3_EP0_COMPLETE;
100 
101 	return 0;
102 }
103 
104 static int __dwc3_gadget_ep0_queue(struct dwc3_ep *dep,
105 		struct dwc3_request *req)
106 {
107 	struct dwc3		*dwc = dep->dwc;
108 
109 	req->request.actual	= 0;
110 	req->request.status	= -EINPROGRESS;
111 	req->epnum		= dep->number;
112 
113 	list_add_tail(&req->list, &dep->request_list);
114 
115 	/*
116 	 * Gadget driver might not be quick enough to queue a request
117 	 * before we get a Transfer Not Ready event on this endpoint.
118 	 *
119 	 * In that case, we will set DWC3_EP_PENDING_REQUEST. When that
120 	 * flag is set, it's telling us that as soon as Gadget queues the
121 	 * required request, we should kick the transfer here because the
122 	 * IRQ we were waiting for is long gone.
123 	 */
124 	if (dep->flags & DWC3_EP_PENDING_REQUEST) {
125 		unsigned	direction;
126 
127 		direction = !!(dep->flags & DWC3_EP0_DIR_IN);
128 
129 		if (dwc->ep0state != EP0_DATA_PHASE) {
130 			dev_WARN(dwc->dev, "Unexpected pending request\n");
131 			return 0;
132 		}
133 
134 		__dwc3_ep0_do_control_data(dwc, dwc->eps[direction], req);
135 
136 		dep->flags &= ~(DWC3_EP_PENDING_REQUEST |
137 				DWC3_EP0_DIR_IN);
138 
139 		return 0;
140 	}
141 
142 	/*
143 	 * In case gadget driver asked us to delay the STATUS phase,
144 	 * handle it here.
145 	 */
146 	if (dwc->delayed_status) {
147 		unsigned	direction;
148 
149 		direction = !dwc->ep0_expect_in;
150 		dwc->delayed_status = false;
151 		usb_gadget_set_state(&dwc->gadget, USB_STATE_CONFIGURED);
152 
153 		if (dwc->ep0state == EP0_STATUS_PHASE)
154 			__dwc3_ep0_do_control_status(dwc, dwc->eps[direction]);
155 		else
156 			dev_dbg(dwc->dev, "too early for delayed status\n");
157 
158 		return 0;
159 	}
160 
161 	/*
162 	 * Unfortunately we have uncovered a limitation wrt the Data Phase.
163 	 *
164 	 * Section 9.4 says we can wait for the XferNotReady(DATA) event to
165 	 * come before issueing Start Transfer command, but if we do, we will
166 	 * miss situations where the host starts another SETUP phase instead of
167 	 * the DATA phase.  Such cases happen at least on TD.7.6 of the Link
168 	 * Layer Compliance Suite.
169 	 *
170 	 * The problem surfaces due to the fact that in case of back-to-back
171 	 * SETUP packets there will be no XferNotReady(DATA) generated and we
172 	 * will be stuck waiting for XferNotReady(DATA) forever.
173 	 *
174 	 * By looking at tables 9-13 and 9-14 of the Databook, we can see that
175 	 * it tells us to start Data Phase right away. It also mentions that if
176 	 * we receive a SETUP phase instead of the DATA phase, core will issue
177 	 * XferComplete for the DATA phase, before actually initiating it in
178 	 * the wire, with the TRB's status set to "SETUP_PENDING". Such status
179 	 * can only be used to print some debugging logs, as the core expects
180 	 * us to go through to the STATUS phase and start a CONTROL_STATUS TRB,
181 	 * just so it completes right away, without transferring anything and,
182 	 * only then, we can go back to the SETUP phase.
183 	 *
184 	 * Because of this scenario, SNPS decided to change the programming
185 	 * model of control transfers and support on-demand transfers only for
186 	 * the STATUS phase. To fix the issue we have now, we will always wait
187 	 * for gadget driver to queue the DATA phase's struct usb_request, then
188 	 * start it right away.
189 	 *
190 	 * If we're actually in a 2-stage transfer, we will wait for
191 	 * XferNotReady(STATUS).
192 	 */
193 	if (dwc->three_stage_setup) {
194 		unsigned        direction;
195 
196 		direction = dwc->ep0_expect_in;
197 		dwc->ep0state = EP0_DATA_PHASE;
198 
199 		__dwc3_ep0_do_control_data(dwc, dwc->eps[direction], req);
200 
201 		dep->flags &= ~DWC3_EP0_DIR_IN;
202 	}
203 
204 	return 0;
205 }
206 
207 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
208 		gfp_t gfp_flags)
209 {
210 	struct dwc3_request		*req = to_dwc3_request(request);
211 	struct dwc3_ep			*dep = to_dwc3_ep(ep);
212 	struct dwc3			*dwc = dep->dwc;
213 
214 	unsigned long			flags;
215 
216 	int				ret;
217 
218 	spin_lock_irqsave(&dwc->lock, flags);
219 	if (!dep->endpoint.desc) {
220 		dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",
221 				request, dep->name);
222 		ret = -ESHUTDOWN;
223 		goto out;
224 	}
225 
226 	/* we share one TRB for ep0/1 */
227 	if (!list_empty(&dep->request_list)) {
228 		ret = -EBUSY;
229 		goto out;
230 	}
231 
232 	dev_vdbg(dwc->dev, "queueing request %p to %s length %d, state '%s'\n",
233 			request, dep->name, request->length,
234 			dwc3_ep0_state_string(dwc->ep0state));
235 
236 	ret = __dwc3_gadget_ep0_queue(dep, req);
237 
238 out:
239 	spin_unlock_irqrestore(&dwc->lock, flags);
240 
241 	return ret;
242 }
243 
244 static void dwc3_ep0_stall_and_restart(struct dwc3 *dwc)
245 {
246 	struct dwc3_ep		*dep;
247 
248 	/* reinitialize physical ep1 */
249 	dep = dwc->eps[1];
250 	dep->flags = DWC3_EP_ENABLED;
251 
252 	/* stall is always issued on EP0 */
253 	dep = dwc->eps[0];
254 	__dwc3_gadget_ep_set_halt(dep, 1);
255 	dep->flags = DWC3_EP_ENABLED;
256 	dwc->delayed_status = false;
257 
258 	if (!list_empty(&dep->request_list)) {
259 		struct dwc3_request	*req;
260 
261 		req = next_request(&dep->request_list);
262 		dwc3_gadget_giveback(dep, req, -ECONNRESET);
263 	}
264 
265 	dwc->ep0state = EP0_SETUP_PHASE;
266 	dwc3_ep0_out_start(dwc);
267 }
268 
269 int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value)
270 {
271 	struct dwc3_ep			*dep = to_dwc3_ep(ep);
272 	struct dwc3			*dwc = dep->dwc;
273 
274 	dwc3_ep0_stall_and_restart(dwc);
275 
276 	return 0;
277 }
278 
279 void dwc3_ep0_out_start(struct dwc3 *dwc)
280 {
281 	int				ret;
282 
283 	ret = dwc3_ep0_start_trans(dwc, 0, dwc->ctrl_req_addr, 8,
284 			DWC3_TRBCTL_CONTROL_SETUP);
285 	WARN_ON(ret < 0);
286 }
287 
288 static struct dwc3_ep *dwc3_wIndex_to_dep(struct dwc3 *dwc, __le16 wIndex_le)
289 {
290 	struct dwc3_ep		*dep;
291 	u32			windex = le16_to_cpu(wIndex_le);
292 	u32			epnum;
293 
294 	epnum = (windex & USB_ENDPOINT_NUMBER_MASK) << 1;
295 	if ((windex & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN)
296 		epnum |= 1;
297 
298 	dep = dwc->eps[epnum];
299 	if (dep->flags & DWC3_EP_ENABLED)
300 		return dep;
301 
302 	return NULL;
303 }
304 
305 static void dwc3_ep0_status_cmpl(struct usb_ep *ep, struct usb_request *req)
306 {
307 }
308 /*
309  * ch 9.4.5
310  */
311 static int dwc3_ep0_handle_status(struct dwc3 *dwc,
312 		struct usb_ctrlrequest *ctrl)
313 {
314 	struct dwc3_ep		*dep;
315 	u32			recip;
316 	u32			reg;
317 	u16			usb_status = 0;
318 	__le16			*response_pkt;
319 
320 	recip = ctrl->bRequestType & USB_RECIP_MASK;
321 	switch (recip) {
322 	case USB_RECIP_DEVICE:
323 		/*
324 		 * LTM will be set once we know how to set this in HW.
325 		 */
326 		usb_status |= dwc->is_selfpowered << USB_DEVICE_SELF_POWERED;
327 
328 		if (dwc->speed == DWC3_DSTS_SUPERSPEED) {
329 			reg = dwc3_readl(dwc->regs, DWC3_DCTL);
330 			if (reg & DWC3_DCTL_INITU1ENA)
331 				usb_status |= 1 << USB_DEV_STAT_U1_ENABLED;
332 			if (reg & DWC3_DCTL_INITU2ENA)
333 				usb_status |= 1 << USB_DEV_STAT_U2_ENABLED;
334 		}
335 
336 		break;
337 
338 	case USB_RECIP_INTERFACE:
339 		/*
340 		 * Function Remote Wake Capable	D0
341 		 * Function Remote Wakeup	D1
342 		 */
343 		break;
344 
345 	case USB_RECIP_ENDPOINT:
346 		dep = dwc3_wIndex_to_dep(dwc, ctrl->wIndex);
347 		if (!dep)
348 			return -EINVAL;
349 
350 		if (dep->flags & DWC3_EP_STALL)
351 			usb_status = 1 << USB_ENDPOINT_HALT;
352 		break;
353 	default:
354 		return -EINVAL;
355 	};
356 
357 	response_pkt = (__le16 *) dwc->setup_buf;
358 	*response_pkt = cpu_to_le16(usb_status);
359 
360 	dep = dwc->eps[0];
361 	dwc->ep0_usb_req.dep = dep;
362 	dwc->ep0_usb_req.request.length = sizeof(*response_pkt);
363 	dwc->ep0_usb_req.request.buf = dwc->setup_buf;
364 	dwc->ep0_usb_req.request.complete = dwc3_ep0_status_cmpl;
365 
366 	return __dwc3_gadget_ep0_queue(dep, &dwc->ep0_usb_req);
367 }
368 
369 static int dwc3_ep0_handle_feature(struct dwc3 *dwc,
370 		struct usb_ctrlrequest *ctrl, int set)
371 {
372 	struct dwc3_ep		*dep;
373 	u32			recip;
374 	u32			wValue;
375 	u32			wIndex;
376 	u32			reg;
377 	int			ret;
378 	enum usb_device_state	state;
379 
380 	wValue = le16_to_cpu(ctrl->wValue);
381 	wIndex = le16_to_cpu(ctrl->wIndex);
382 	recip = ctrl->bRequestType & USB_RECIP_MASK;
383 	state = dwc->gadget.state;
384 
385 	switch (recip) {
386 	case USB_RECIP_DEVICE:
387 
388 		switch (wValue) {
389 		case USB_DEVICE_REMOTE_WAKEUP:
390 			break;
391 		/*
392 		 * 9.4.1 says only only for SS, in AddressState only for
393 		 * default control pipe
394 		 */
395 		case USB_DEVICE_U1_ENABLE:
396 			if (state != USB_STATE_CONFIGURED)
397 				return -EINVAL;
398 			if (dwc->speed != DWC3_DSTS_SUPERSPEED)
399 				return -EINVAL;
400 
401 			reg = dwc3_readl(dwc->regs, DWC3_DCTL);
402 			if (set)
403 				reg |= DWC3_DCTL_INITU1ENA;
404 			else
405 				reg &= ~DWC3_DCTL_INITU1ENA;
406 			dwc3_writel(dwc->regs, DWC3_DCTL, reg);
407 			break;
408 
409 		case USB_DEVICE_U2_ENABLE:
410 			if (state != USB_STATE_CONFIGURED)
411 				return -EINVAL;
412 			if (dwc->speed != DWC3_DSTS_SUPERSPEED)
413 				return -EINVAL;
414 
415 			reg = dwc3_readl(dwc->regs, DWC3_DCTL);
416 			if (set)
417 				reg |= DWC3_DCTL_INITU2ENA;
418 			else
419 				reg &= ~DWC3_DCTL_INITU2ENA;
420 			dwc3_writel(dwc->regs, DWC3_DCTL, reg);
421 			break;
422 
423 		case USB_DEVICE_LTM_ENABLE:
424 			return -EINVAL;
425 			break;
426 
427 		case USB_DEVICE_TEST_MODE:
428 			if ((wIndex & 0xff) != 0)
429 				return -EINVAL;
430 			if (!set)
431 				return -EINVAL;
432 
433 			dwc->test_mode_nr = wIndex >> 8;
434 			dwc->test_mode = true;
435 			break;
436 		default:
437 			return -EINVAL;
438 		}
439 		break;
440 
441 	case USB_RECIP_INTERFACE:
442 		switch (wValue) {
443 		case USB_INTRF_FUNC_SUSPEND:
444 			if (wIndex & USB_INTRF_FUNC_SUSPEND_LP)
445 				/* XXX enable Low power suspend */
446 				;
447 			if (wIndex & USB_INTRF_FUNC_SUSPEND_RW)
448 				/* XXX enable remote wakeup */
449 				;
450 			break;
451 		default:
452 			return -EINVAL;
453 		}
454 		break;
455 
456 	case USB_RECIP_ENDPOINT:
457 		switch (wValue) {
458 		case USB_ENDPOINT_HALT:
459 			dep = dwc3_wIndex_to_dep(dwc, wIndex);
460 			if (!dep)
461 				return -EINVAL;
462 			ret = __dwc3_gadget_ep_set_halt(dep, set);
463 			if (ret)
464 				return -EINVAL;
465 			break;
466 		default:
467 			return -EINVAL;
468 		}
469 		break;
470 
471 	default:
472 		return -EINVAL;
473 	};
474 
475 	return 0;
476 }
477 
478 static int dwc3_ep0_set_address(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
479 {
480 	enum usb_device_state state = dwc->gadget.state;
481 	u32 addr;
482 	u32 reg;
483 
484 	addr = le16_to_cpu(ctrl->wValue);
485 	if (addr > 127) {
486 		dev_dbg(dwc->dev, "invalid device address %d\n", addr);
487 		return -EINVAL;
488 	}
489 
490 	if (state == USB_STATE_CONFIGURED) {
491 		dev_dbg(dwc->dev, "trying to set address when configured\n");
492 		return -EINVAL;
493 	}
494 
495 	reg = dwc3_readl(dwc->regs, DWC3_DCFG);
496 	reg &= ~(DWC3_DCFG_DEVADDR_MASK);
497 	reg |= DWC3_DCFG_DEVADDR(addr);
498 	dwc3_writel(dwc->regs, DWC3_DCFG, reg);
499 
500 	if (addr)
501 		usb_gadget_set_state(&dwc->gadget, USB_STATE_ADDRESS);
502 	else
503 		usb_gadget_set_state(&dwc->gadget, USB_STATE_DEFAULT);
504 
505 	return 0;
506 }
507 
508 static int dwc3_ep0_delegate_req(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
509 {
510 	int ret;
511 
512 	spin_unlock(&dwc->lock);
513 	ret = dwc->gadget_driver->setup(&dwc->gadget, ctrl);
514 	spin_lock(&dwc->lock);
515 	return ret;
516 }
517 
518 static int dwc3_ep0_set_config(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
519 {
520 	enum usb_device_state state = dwc->gadget.state;
521 	u32 cfg;
522 	int ret;
523 	u32 reg;
524 
525 	dwc->start_config_issued = false;
526 	cfg = le16_to_cpu(ctrl->wValue);
527 
528 	switch (state) {
529 	case USB_STATE_DEFAULT:
530 		return -EINVAL;
531 		break;
532 
533 	case USB_STATE_ADDRESS:
534 		ret = dwc3_ep0_delegate_req(dwc, ctrl);
535 		/* if the cfg matches and the cfg is non zero */
536 		if (cfg && (!ret || (ret == USB_GADGET_DELAYED_STATUS))) {
537 
538 			/*
539 			 * only change state if set_config has already
540 			 * been processed. If gadget driver returns
541 			 * USB_GADGET_DELAYED_STATUS, we will wait
542 			 * to change the state on the next usb_ep_queue()
543 			 */
544 			if (ret == 0)
545 				usb_gadget_set_state(&dwc->gadget,
546 						USB_STATE_CONFIGURED);
547 
548 			/*
549 			 * Enable transition to U1/U2 state when
550 			 * nothing is pending from application.
551 			 */
552 			reg = dwc3_readl(dwc->regs, DWC3_DCTL);
553 			reg |= (DWC3_DCTL_ACCEPTU1ENA | DWC3_DCTL_ACCEPTU2ENA);
554 			dwc3_writel(dwc->regs, DWC3_DCTL, reg);
555 
556 			dwc->resize_fifos = true;
557 			dev_dbg(dwc->dev, "resize fifos flag SET\n");
558 		}
559 		break;
560 
561 	case USB_STATE_CONFIGURED:
562 		ret = dwc3_ep0_delegate_req(dwc, ctrl);
563 		if (!cfg && !ret)
564 			usb_gadget_set_state(&dwc->gadget,
565 					USB_STATE_ADDRESS);
566 		break;
567 	default:
568 		ret = -EINVAL;
569 	}
570 	return ret;
571 }
572 
573 static void dwc3_ep0_set_sel_cmpl(struct usb_ep *ep, struct usb_request *req)
574 {
575 	struct dwc3_ep	*dep = to_dwc3_ep(ep);
576 	struct dwc3	*dwc = dep->dwc;
577 
578 	u32		param = 0;
579 	u32		reg;
580 
581 	struct timing {
582 		u8	u1sel;
583 		u8	u1pel;
584 		u16	u2sel;
585 		u16	u2pel;
586 	} __packed timing;
587 
588 	int		ret;
589 
590 	memcpy(&timing, req->buf, sizeof(timing));
591 
592 	dwc->u1sel = timing.u1sel;
593 	dwc->u1pel = timing.u1pel;
594 	dwc->u2sel = le16_to_cpu(timing.u2sel);
595 	dwc->u2pel = le16_to_cpu(timing.u2pel);
596 
597 	reg = dwc3_readl(dwc->regs, DWC3_DCTL);
598 	if (reg & DWC3_DCTL_INITU2ENA)
599 		param = dwc->u2pel;
600 	if (reg & DWC3_DCTL_INITU1ENA)
601 		param = dwc->u1pel;
602 
603 	/*
604 	 * According to Synopsys Databook, if parameter is
605 	 * greater than 125, a value of zero should be
606 	 * programmed in the register.
607 	 */
608 	if (param > 125)
609 		param = 0;
610 
611 	/* now that we have the time, issue DGCMD Set Sel */
612 	ret = dwc3_send_gadget_generic_command(dwc,
613 			DWC3_DGCMD_SET_PERIODIC_PAR, param);
614 	WARN_ON(ret < 0);
615 }
616 
617 static int dwc3_ep0_set_sel(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
618 {
619 	struct dwc3_ep	*dep;
620 	enum usb_device_state state = dwc->gadget.state;
621 	u16		wLength;
622 	u16		wValue;
623 
624 	if (state == USB_STATE_DEFAULT)
625 		return -EINVAL;
626 
627 	wValue = le16_to_cpu(ctrl->wValue);
628 	wLength = le16_to_cpu(ctrl->wLength);
629 
630 	if (wLength != 6) {
631 		dev_err(dwc->dev, "Set SEL should be 6 bytes, got %d\n",
632 				wLength);
633 		return -EINVAL;
634 	}
635 
636 	/*
637 	 * To handle Set SEL we need to receive 6 bytes from Host. So let's
638 	 * queue a usb_request for 6 bytes.
639 	 *
640 	 * Remember, though, this controller can't handle non-wMaxPacketSize
641 	 * aligned transfers on the OUT direction, so we queue a request for
642 	 * wMaxPacketSize instead.
643 	 */
644 	dep = dwc->eps[0];
645 	dwc->ep0_usb_req.dep = dep;
646 	dwc->ep0_usb_req.request.length = dep->endpoint.maxpacket;
647 	dwc->ep0_usb_req.request.buf = dwc->setup_buf;
648 	dwc->ep0_usb_req.request.complete = dwc3_ep0_set_sel_cmpl;
649 
650 	return __dwc3_gadget_ep0_queue(dep, &dwc->ep0_usb_req);
651 }
652 
653 static int dwc3_ep0_set_isoch_delay(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
654 {
655 	u16		wLength;
656 	u16		wValue;
657 	u16		wIndex;
658 
659 	wValue = le16_to_cpu(ctrl->wValue);
660 	wLength = le16_to_cpu(ctrl->wLength);
661 	wIndex = le16_to_cpu(ctrl->wIndex);
662 
663 	if (wIndex || wLength)
664 		return -EINVAL;
665 
666 	/*
667 	 * REVISIT It's unclear from Databook what to do with this
668 	 * value. For now, just cache it.
669 	 */
670 	dwc->isoch_delay = wValue;
671 
672 	return 0;
673 }
674 
675 static int dwc3_ep0_std_request(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl)
676 {
677 	int ret;
678 
679 	switch (ctrl->bRequest) {
680 	case USB_REQ_GET_STATUS:
681 		dev_vdbg(dwc->dev, "USB_REQ_GET_STATUS\n");
682 		ret = dwc3_ep0_handle_status(dwc, ctrl);
683 		break;
684 	case USB_REQ_CLEAR_FEATURE:
685 		dev_vdbg(dwc->dev, "USB_REQ_CLEAR_FEATURE\n");
686 		ret = dwc3_ep0_handle_feature(dwc, ctrl, 0);
687 		break;
688 	case USB_REQ_SET_FEATURE:
689 		dev_vdbg(dwc->dev, "USB_REQ_SET_FEATURE\n");
690 		ret = dwc3_ep0_handle_feature(dwc, ctrl, 1);
691 		break;
692 	case USB_REQ_SET_ADDRESS:
693 		dev_vdbg(dwc->dev, "USB_REQ_SET_ADDRESS\n");
694 		ret = dwc3_ep0_set_address(dwc, ctrl);
695 		break;
696 	case USB_REQ_SET_CONFIGURATION:
697 		dev_vdbg(dwc->dev, "USB_REQ_SET_CONFIGURATION\n");
698 		ret = dwc3_ep0_set_config(dwc, ctrl);
699 		break;
700 	case USB_REQ_SET_SEL:
701 		dev_vdbg(dwc->dev, "USB_REQ_SET_SEL\n");
702 		ret = dwc3_ep0_set_sel(dwc, ctrl);
703 		break;
704 	case USB_REQ_SET_ISOCH_DELAY:
705 		dev_vdbg(dwc->dev, "USB_REQ_SET_ISOCH_DELAY\n");
706 		ret = dwc3_ep0_set_isoch_delay(dwc, ctrl);
707 		break;
708 	default:
709 		dev_vdbg(dwc->dev, "Forwarding to gadget driver\n");
710 		ret = dwc3_ep0_delegate_req(dwc, ctrl);
711 		break;
712 	};
713 
714 	return ret;
715 }
716 
717 static void dwc3_ep0_inspect_setup(struct dwc3 *dwc,
718 		const struct dwc3_event_depevt *event)
719 {
720 	struct usb_ctrlrequest *ctrl = dwc->ctrl_req;
721 	int ret = -EINVAL;
722 	u32 len;
723 
724 	if (!dwc->gadget_driver)
725 		goto out;
726 
727 	len = le16_to_cpu(ctrl->wLength);
728 	if (!len) {
729 		dwc->three_stage_setup = false;
730 		dwc->ep0_expect_in = false;
731 		dwc->ep0_next_event = DWC3_EP0_NRDY_STATUS;
732 	} else {
733 		dwc->three_stage_setup = true;
734 		dwc->ep0_expect_in = !!(ctrl->bRequestType & USB_DIR_IN);
735 		dwc->ep0_next_event = DWC3_EP0_NRDY_DATA;
736 	}
737 
738 	if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD)
739 		ret = dwc3_ep0_std_request(dwc, ctrl);
740 	else
741 		ret = dwc3_ep0_delegate_req(dwc, ctrl);
742 
743 	if (ret == USB_GADGET_DELAYED_STATUS)
744 		dwc->delayed_status = true;
745 
746 out:
747 	if (ret < 0)
748 		dwc3_ep0_stall_and_restart(dwc);
749 }
750 
751 static void dwc3_ep0_complete_data(struct dwc3 *dwc,
752 		const struct dwc3_event_depevt *event)
753 {
754 	struct dwc3_request	*r = NULL;
755 	struct usb_request	*ur;
756 	struct dwc3_trb		*trb;
757 	struct dwc3_ep		*ep0;
758 	u32			transferred;
759 	u32			status;
760 	u32			length;
761 	u8			epnum;
762 
763 	epnum = event->endpoint_number;
764 	ep0 = dwc->eps[0];
765 
766 	dwc->ep0_next_event = DWC3_EP0_NRDY_STATUS;
767 
768 	r = next_request(&ep0->request_list);
769 	ur = &r->request;
770 
771 	trb = dwc->ep0_trb;
772 
773 	status = DWC3_TRB_SIZE_TRBSTS(trb->size);
774 	if (status == DWC3_TRBSTS_SETUP_PENDING) {
775 		dev_dbg(dwc->dev, "Setup Pending received\n");
776 
777 		if (r)
778 			dwc3_gadget_giveback(ep0, r, -ECONNRESET);
779 
780 		return;
781 	}
782 
783 	length = trb->size & DWC3_TRB_SIZE_MASK;
784 
785 	if (dwc->ep0_bounced) {
786 		unsigned transfer_size = ur->length;
787 		unsigned maxp = ep0->endpoint.maxpacket;
788 
789 		transfer_size += (maxp - (transfer_size % maxp));
790 		transferred = min_t(u32, ur->length,
791 				transfer_size - length);
792 		memcpy(ur->buf, dwc->ep0_bounce, transferred);
793 	} else {
794 		transferred = ur->length - length;
795 	}
796 
797 	ur->actual += transferred;
798 
799 	if ((epnum & 1) && ur->actual < ur->length) {
800 		/* for some reason we did not get everything out */
801 
802 		dwc3_ep0_stall_and_restart(dwc);
803 	} else {
804 		/*
805 		 * handle the case where we have to send a zero packet. This
806 		 * seems to be case when req.length > maxpacket. Could it be?
807 		 */
808 		if (r)
809 			dwc3_gadget_giveback(ep0, r, 0);
810 	}
811 }
812 
813 static void dwc3_ep0_complete_status(struct dwc3 *dwc,
814 		const struct dwc3_event_depevt *event)
815 {
816 	struct dwc3_request	*r;
817 	struct dwc3_ep		*dep;
818 	struct dwc3_trb		*trb;
819 	u32			status;
820 
821 	dep = dwc->eps[0];
822 	trb = dwc->ep0_trb;
823 
824 	if (!list_empty(&dep->request_list)) {
825 		r = next_request(&dep->request_list);
826 
827 		dwc3_gadget_giveback(dep, r, 0);
828 	}
829 
830 	if (dwc->test_mode) {
831 		int ret;
832 
833 		ret = dwc3_gadget_set_test_mode(dwc, dwc->test_mode_nr);
834 		if (ret < 0) {
835 			dev_dbg(dwc->dev, "Invalid Test #%d\n",
836 					dwc->test_mode_nr);
837 			dwc3_ep0_stall_and_restart(dwc);
838 			return;
839 		}
840 	}
841 
842 	status = DWC3_TRB_SIZE_TRBSTS(trb->size);
843 	if (status == DWC3_TRBSTS_SETUP_PENDING)
844 		dev_dbg(dwc->dev, "Setup Pending received\n");
845 
846 	dwc->ep0state = EP0_SETUP_PHASE;
847 	dwc3_ep0_out_start(dwc);
848 }
849 
850 static void dwc3_ep0_xfer_complete(struct dwc3 *dwc,
851 			const struct dwc3_event_depevt *event)
852 {
853 	struct dwc3_ep		*dep = dwc->eps[event->endpoint_number];
854 
855 	dep->flags &= ~DWC3_EP_BUSY;
856 	dep->resource_index = 0;
857 	dwc->setup_packet_pending = false;
858 
859 	switch (dwc->ep0state) {
860 	case EP0_SETUP_PHASE:
861 		dev_vdbg(dwc->dev, "Inspecting Setup Bytes\n");
862 		dwc3_ep0_inspect_setup(dwc, event);
863 		break;
864 
865 	case EP0_DATA_PHASE:
866 		dev_vdbg(dwc->dev, "Data Phase\n");
867 		dwc3_ep0_complete_data(dwc, event);
868 		break;
869 
870 	case EP0_STATUS_PHASE:
871 		dev_vdbg(dwc->dev, "Status Phase\n");
872 		dwc3_ep0_complete_status(dwc, event);
873 		break;
874 	default:
875 		WARN(true, "UNKNOWN ep0state %d\n", dwc->ep0state);
876 	}
877 }
878 
879 static void __dwc3_ep0_do_control_data(struct dwc3 *dwc,
880 		struct dwc3_ep *dep, struct dwc3_request *req)
881 {
882 	int			ret;
883 
884 	req->direction = !!dep->number;
885 
886 	if (req->request.length == 0) {
887 		ret = dwc3_ep0_start_trans(dwc, dep->number,
888 				dwc->ctrl_req_addr, 0,
889 				DWC3_TRBCTL_CONTROL_DATA);
890 	} else if (!IS_ALIGNED(req->request.length, dep->endpoint.maxpacket)
891 			&& (dep->number == 0)) {
892 		u32	transfer_size;
893 		u32	maxpacket;
894 
895 		ret = usb_gadget_map_request(&dwc->gadget, &req->request,
896 				dep->number);
897 		if (ret) {
898 			dev_dbg(dwc->dev, "failed to map request\n");
899 			return;
900 		}
901 
902 		WARN_ON(req->request.length > DWC3_EP0_BOUNCE_SIZE);
903 
904 		maxpacket = dep->endpoint.maxpacket;
905 		transfer_size = roundup(req->request.length, maxpacket);
906 
907 		dwc->ep0_bounced = true;
908 
909 		/*
910 		 * REVISIT in case request length is bigger than
911 		 * DWC3_EP0_BOUNCE_SIZE we will need two chained
912 		 * TRBs to handle the transfer.
913 		 */
914 		ret = dwc3_ep0_start_trans(dwc, dep->number,
915 				dwc->ep0_bounce_addr, transfer_size,
916 				DWC3_TRBCTL_CONTROL_DATA);
917 	} else {
918 		ret = usb_gadget_map_request(&dwc->gadget, &req->request,
919 				dep->number);
920 		if (ret) {
921 			dev_dbg(dwc->dev, "failed to map request\n");
922 			return;
923 		}
924 
925 		ret = dwc3_ep0_start_trans(dwc, dep->number, req->request.dma,
926 				req->request.length, DWC3_TRBCTL_CONTROL_DATA);
927 	}
928 
929 	WARN_ON(ret < 0);
930 }
931 
932 static int dwc3_ep0_start_control_status(struct dwc3_ep *dep)
933 {
934 	struct dwc3		*dwc = dep->dwc;
935 	u32			type;
936 
937 	type = dwc->three_stage_setup ? DWC3_TRBCTL_CONTROL_STATUS3
938 		: DWC3_TRBCTL_CONTROL_STATUS2;
939 
940 	return dwc3_ep0_start_trans(dwc, dep->number,
941 			dwc->ctrl_req_addr, 0, type);
942 }
943 
944 static void __dwc3_ep0_do_control_status(struct dwc3 *dwc, struct dwc3_ep *dep)
945 {
946 	if (dwc->resize_fifos) {
947 		dev_dbg(dwc->dev, "starting to resize fifos\n");
948 		dwc3_gadget_resize_tx_fifos(dwc);
949 		dwc->resize_fifos = 0;
950 	}
951 
952 	WARN_ON(dwc3_ep0_start_control_status(dep));
953 }
954 
955 static void dwc3_ep0_do_control_status(struct dwc3 *dwc,
956 		const struct dwc3_event_depevt *event)
957 {
958 	struct dwc3_ep		*dep = dwc->eps[event->endpoint_number];
959 
960 	__dwc3_ep0_do_control_status(dwc, dep);
961 }
962 
963 static void dwc3_ep0_end_control_data(struct dwc3 *dwc, struct dwc3_ep *dep)
964 {
965 	struct dwc3_gadget_ep_cmd_params params;
966 	u32			cmd;
967 	int			ret;
968 
969 	if (!dep->resource_index)
970 		return;
971 
972 	cmd = DWC3_DEPCMD_ENDTRANSFER;
973 	cmd |= DWC3_DEPCMD_CMDIOC;
974 	cmd |= DWC3_DEPCMD_PARAM(dep->resource_index);
975 	memset(&params, 0, sizeof(params));
976 	ret = dwc3_send_gadget_ep_cmd(dwc, dep->number, cmd, &params);
977 	WARN_ON_ONCE(ret);
978 	dep->resource_index = 0;
979 }
980 
981 static void dwc3_ep0_xfernotready(struct dwc3 *dwc,
982 		const struct dwc3_event_depevt *event)
983 {
984 	dwc->setup_packet_pending = true;
985 
986 	switch (event->status) {
987 	case DEPEVT_STATUS_CONTROL_DATA:
988 		dev_vdbg(dwc->dev, "Control Data\n");
989 
990 		/*
991 		 * We already have a DATA transfer in the controller's cache,
992 		 * if we receive a XferNotReady(DATA) we will ignore it, unless
993 		 * it's for the wrong direction.
994 		 *
995 		 * In that case, we must issue END_TRANSFER command to the Data
996 		 * Phase we already have started and issue SetStall on the
997 		 * control endpoint.
998 		 */
999 		if (dwc->ep0_expect_in != event->endpoint_number) {
1000 			struct dwc3_ep	*dep = dwc->eps[dwc->ep0_expect_in];
1001 
1002 			dev_vdbg(dwc->dev, "Wrong direction for Data phase\n");
1003 			dwc3_ep0_end_control_data(dwc, dep);
1004 			dwc3_ep0_stall_and_restart(dwc);
1005 			return;
1006 		}
1007 
1008 		break;
1009 
1010 	case DEPEVT_STATUS_CONTROL_STATUS:
1011 		if (dwc->ep0_next_event != DWC3_EP0_NRDY_STATUS)
1012 			return;
1013 
1014 		dev_vdbg(dwc->dev, "Control Status\n");
1015 
1016 		dwc->ep0state = EP0_STATUS_PHASE;
1017 
1018 		if (dwc->delayed_status) {
1019 			WARN_ON_ONCE(event->endpoint_number != 1);
1020 			dev_vdbg(dwc->dev, "Mass Storage delayed status\n");
1021 			return;
1022 		}
1023 
1024 		dwc3_ep0_do_control_status(dwc, event);
1025 	}
1026 }
1027 
1028 void dwc3_ep0_interrupt(struct dwc3 *dwc,
1029 		const struct dwc3_event_depevt *event)
1030 {
1031 	u8			epnum = event->endpoint_number;
1032 
1033 	dev_dbg(dwc->dev, "%s while ep%d%s in state '%s'\n",
1034 			dwc3_ep_event_string(event->endpoint_event),
1035 			epnum >> 1, (epnum & 1) ? "in" : "out",
1036 			dwc3_ep0_state_string(dwc->ep0state));
1037 
1038 	switch (event->endpoint_event) {
1039 	case DWC3_DEPEVT_XFERCOMPLETE:
1040 		dwc3_ep0_xfer_complete(dwc, event);
1041 		break;
1042 
1043 	case DWC3_DEPEVT_XFERNOTREADY:
1044 		dwc3_ep0_xfernotready(dwc, event);
1045 		break;
1046 
1047 	case DWC3_DEPEVT_XFERINPROGRESS:
1048 	case DWC3_DEPEVT_RXTXFIFOEVT:
1049 	case DWC3_DEPEVT_STREAMEVT:
1050 	case DWC3_DEPEVT_EPCMDCMPLT:
1051 		break;
1052 	}
1053 }
1054