1 // SPDX-License-Identifier: GPL-2.0
3 * mtu3_gadget.c - MediaTek usb3 DRD peripheral support
5 * Copyright (C) 2016 MediaTek Inc.
7 * Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
11 #include "mtu3_trace.h"
13 void mtu3_req_complete(struct mtu3_ep *mep,
14 struct usb_request *req, int status)
15 __releases(mep->mtu->lock)
16 __acquires(mep->mtu->lock)
18 struct mtu3_request *mreq = to_mtu3_request(req);
19 struct mtu3 *mtu = mreq->mtu;
21 list_del(&mreq->list);
22 if (req->status == -EINPROGRESS)
25 trace_mtu3_req_complete(mreq);
27 /* ep0 makes use of PIO, needn't unmap it */
29 usb_gadget_unmap_request(&mtu->g, req, mep->is_in);
31 dev_dbg(mtu->dev, "%s complete req: %p, sts %d, %d/%d\n",
32 mep->name, req, req->status, req->actual, req->length);
34 spin_unlock(&mtu->lock);
35 usb_gadget_giveback_request(&mep->ep, req);
36 spin_lock(&mtu->lock);
39 static void nuke(struct mtu3_ep *mep, const int status)
41 struct mtu3_request *mreq = NULL;
43 if (list_empty(&mep->req_list))
46 dev_dbg(mep->mtu->dev, "abort %s's req: sts %d\n", mep->name, status);
52 while (!list_empty(&mep->req_list)) {
53 mreq = list_first_entry(&mep->req_list,
54 struct mtu3_request, list);
55 mtu3_req_complete(mep, &mreq->request, status);
59 static int mtu3_ep_enable(struct mtu3_ep *mep)
61 const struct usb_endpoint_descriptor *desc;
62 const struct usb_ss_ep_comp_descriptor *comp_desc;
63 struct mtu3 *mtu = mep->mtu;
70 comp_desc = mep->comp_desc;
71 mep->type = usb_endpoint_type(desc);
72 mep->maxp = usb_endpoint_maxp(desc);
74 switch (mtu->g.speed) {
76 case USB_SPEED_SUPER_PLUS:
77 if (usb_endpoint_xfer_int(desc) ||
78 usb_endpoint_xfer_isoc(desc)) {
79 interval = desc->bInterval;
80 interval = clamp_val(interval, 1, 16);
81 if (usb_endpoint_xfer_isoc(desc) && comp_desc)
82 mult = comp_desc->bmAttributes;
85 burst = comp_desc->bMaxBurst;
89 if (usb_endpoint_xfer_isoc(desc) ||
90 usb_endpoint_xfer_int(desc)) {
91 interval = desc->bInterval;
92 interval = clamp_val(interval, 1, 16);
93 mult = usb_endpoint_maxp_mult(desc) - 1;
97 if (usb_endpoint_xfer_isoc(desc))
98 interval = clamp_val(desc->bInterval, 1, 16);
99 else if (usb_endpoint_xfer_int(desc))
100 interval = clamp_val(desc->bInterval, 1, 255);
104 break; /*others are ignored */
107 dev_dbg(mtu->dev, "%s maxp:%d, interval:%d, burst:%d, mult:%d\n",
108 __func__, mep->maxp, interval, burst, mult);
110 mep->ep.maxpacket = mep->maxp;
112 mep->ep.comp_desc = comp_desc;
114 /* slot mainly affects bulk/isoc transfer, so ignore int */
115 mep->slot = usb_endpoint_xfer_int(desc) ? 0 : mtu->slot;
117 ret = mtu3_config_ep(mtu, mep, interval, burst, mult);
121 ret = mtu3_gpd_ring_alloc(mep);
123 mtu3_deconfig_ep(mtu, mep);
132 static int mtu3_ep_disable(struct mtu3_ep *mep)
134 struct mtu3 *mtu = mep->mtu;
136 /* abort all pending requests */
137 nuke(mep, -ESHUTDOWN);
139 mtu3_deconfig_ep(mtu, mep);
140 mtu3_gpd_ring_free(mep);
144 mep->comp_desc = NULL;
151 static int mtu3_gadget_ep_enable(struct usb_ep *ep,
152 const struct usb_endpoint_descriptor *desc)
159 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
160 pr_debug("%s invalid parameters\n", __func__);
164 if (!desc->wMaxPacketSize) {
165 pr_debug("%s missing wMaxPacketSize\n", __func__);
168 mep = to_mtu3_ep(ep);
171 /* check ep number and direction against endpoint */
172 if (usb_endpoint_num(desc) != mep->epnum)
175 if (!!usb_endpoint_dir_in(desc) ^ !!mep->is_in)
178 dev_dbg(mtu->dev, "%s %s\n", __func__, ep->name);
180 if (mep->flags & MTU3_EP_ENABLED) {
181 dev_WARN_ONCE(mtu->dev, true, "%s is already enabled\n",
186 spin_lock_irqsave(&mtu->lock, flags);
188 mep->comp_desc = ep->comp_desc;
190 ret = mtu3_ep_enable(mep);
194 mep->flags = MTU3_EP_ENABLED;
198 spin_unlock_irqrestore(&mtu->lock, flags);
200 dev_dbg(mtu->dev, "%s active_ep=%d\n", __func__, mtu->active_ep);
201 trace_mtu3_gadget_ep_enable(mep);
206 static int mtu3_gadget_ep_disable(struct usb_ep *ep)
208 struct mtu3_ep *mep = to_mtu3_ep(ep);
209 struct mtu3 *mtu = mep->mtu;
212 dev_dbg(mtu->dev, "%s %s\n", __func__, mep->name);
213 trace_mtu3_gadget_ep_disable(mep);
215 if (!(mep->flags & MTU3_EP_ENABLED)) {
216 dev_warn(mtu->dev, "%s is already disabled\n", mep->name);
220 spin_lock_irqsave(&mtu->lock, flags);
221 mtu3_ep_disable(mep);
224 spin_unlock_irqrestore(&(mtu->lock), flags);
226 dev_dbg(mtu->dev, "%s active_ep=%d, mtu3 is_active=%d\n",
227 __func__, mtu->active_ep, mtu->is_active);
232 struct usb_request *mtu3_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
234 struct mtu3_ep *mep = to_mtu3_ep(ep);
235 struct mtu3_request *mreq;
237 mreq = kzalloc(sizeof(*mreq), gfp_flags);
241 mreq->request.dma = DMA_ADDR_INVALID;
242 mreq->epnum = mep->epnum;
244 INIT_LIST_HEAD(&mreq->list);
245 trace_mtu3_alloc_request(mreq);
247 return &mreq->request;
250 void mtu3_free_request(struct usb_ep *ep, struct usb_request *req)
252 struct mtu3_request *mreq = to_mtu3_request(req);
254 trace_mtu3_free_request(mreq);
258 static int mtu3_gadget_queue(struct usb_ep *ep,
259 struct usb_request *req, gfp_t gfp_flags)
261 struct mtu3_ep *mep = to_mtu3_ep(ep);
262 struct mtu3_request *mreq = to_mtu3_request(req);
263 struct mtu3 *mtu = mep->mtu;
270 if (mreq->mep != mep)
273 dev_dbg(mtu->dev, "%s %s EP%d(%s), req=%p, maxp=%d, len#%d\n",
274 __func__, mep->is_in ? "TX" : "RX", mreq->epnum, ep->name,
275 mreq, ep->maxpacket, mreq->request.length);
277 if (req->length > GPD_BUF_SIZE ||
278 (mtu->gen2cp && req->length > GPD_BUF_SIZE_EL)) {
280 "req length > supported MAX:%d requested:%d\n",
281 mtu->gen2cp ? GPD_BUF_SIZE_EL : GPD_BUF_SIZE,
286 /* don't queue if the ep is down */
288 dev_dbg(mtu->dev, "req=%p queued to %s while it's disabled\n",
294 mreq->request.actual = 0;
295 mreq->request.status = -EINPROGRESS;
297 ret = usb_gadget_map_request(&mtu->g, req, mep->is_in);
299 dev_err(mtu->dev, "dma mapping failed\n");
303 spin_lock_irqsave(&mtu->lock, flags);
305 if (mtu3_prepare_transfer(mep)) {
310 list_add_tail(&mreq->list, &mep->req_list);
311 mtu3_insert_gpd(mep, mreq);
312 mtu3_qmu_resume(mep);
315 spin_unlock_irqrestore(&mtu->lock, flags);
316 trace_mtu3_gadget_queue(mreq);
321 static int mtu3_gadget_dequeue(struct usb_ep *ep, struct usb_request *req)
323 struct mtu3_ep *mep = to_mtu3_ep(ep);
324 struct mtu3_request *mreq = to_mtu3_request(req);
325 struct mtu3_request *r;
326 struct mtu3 *mtu = mep->mtu;
330 if (mreq->mep != mep)
333 dev_dbg(mtu->dev, "%s : req=%p\n", __func__, req);
334 trace_mtu3_gadget_dequeue(mreq);
336 spin_lock_irqsave(&mtu->lock, flags);
338 list_for_each_entry(r, &mep->req_list, list) {
343 dev_dbg(mtu->dev, "req=%p not queued to %s\n", req, ep->name);
348 mtu3_qmu_flush(mep); /* REVISIT: set BPS ?? */
349 mtu3_req_complete(mep, req, -ECONNRESET);
353 spin_unlock_irqrestore(&mtu->lock, flags);
359 * Set or clear the halt bit of an EP.
360 * A halted EP won't TX/RX any data but will queue requests.
362 static int mtu3_gadget_ep_set_halt(struct usb_ep *ep, int value)
364 struct mtu3_ep *mep = to_mtu3_ep(ep);
365 struct mtu3 *mtu = mep->mtu;
366 struct mtu3_request *mreq;
370 dev_dbg(mtu->dev, "%s : %s...", __func__, ep->name);
372 spin_lock_irqsave(&mtu->lock, flags);
374 if (mep->type == USB_ENDPOINT_XFER_ISOC) {
379 mreq = next_request(mep);
382 * If there is not request for TX-EP, QMU will not transfer
383 * data to TX-FIFO, so no need check whether TX-FIFO
384 * holds bytes or not here
387 dev_dbg(mtu->dev, "req in progress, cannot halt %s\n",
393 mep->flags &= ~MTU3_EP_WEDGE;
396 dev_dbg(mtu->dev, "%s %s stall\n", ep->name, value ? "set" : "clear");
398 mtu3_ep_stall_set(mep, value);
401 spin_unlock_irqrestore(&mtu->lock, flags);
402 trace_mtu3_gadget_ep_set_halt(mep);
407 /* Sets the halt feature with the clear requests ignored */
408 static int mtu3_gadget_ep_set_wedge(struct usb_ep *ep)
410 struct mtu3_ep *mep = to_mtu3_ep(ep);
412 mep->flags |= MTU3_EP_WEDGE;
414 return usb_ep_set_halt(ep);
417 static const struct usb_ep_ops mtu3_ep_ops = {
418 .enable = mtu3_gadget_ep_enable,
419 .disable = mtu3_gadget_ep_disable,
420 .alloc_request = mtu3_alloc_request,
421 .free_request = mtu3_free_request,
422 .queue = mtu3_gadget_queue,
423 .dequeue = mtu3_gadget_dequeue,
424 .set_halt = mtu3_gadget_ep_set_halt,
425 .set_wedge = mtu3_gadget_ep_set_wedge,
428 static int mtu3_gadget_get_frame(struct usb_gadget *gadget)
430 struct mtu3 *mtu = gadget_to_mtu3(gadget);
432 return (int)mtu3_readl(mtu->mac_base, U3D_USB20_FRAME_NUM);
435 static void function_wake_notif(struct mtu3 *mtu, u8 intf)
437 mtu3_writel(mtu->mac_base, U3D_DEV_NOTIF_0,
438 TYPE_FUNCTION_WAKE | DEV_NOTIF_VAL_FW(intf));
439 mtu3_setbits(mtu->mac_base, U3D_DEV_NOTIF_0, SEND_DEV_NOTIF);
442 static int mtu3_gadget_wakeup(struct usb_gadget *gadget)
444 struct mtu3 *mtu = gadget_to_mtu3(gadget);
447 dev_dbg(mtu->dev, "%s\n", __func__);
449 /* remote wakeup feature is not enabled by host */
450 if (!mtu->may_wakeup)
453 spin_lock_irqsave(&mtu->lock, flags);
454 if (mtu->g.speed >= USB_SPEED_SUPER) {
456 * class driver may do function wakeup even UFP is in U0,
457 * and UX_EXIT only takes effect in U1/U2/U3;
459 mtu3_setbits(mtu->mac_base, U3D_LINK_POWER_CONTROL, UX_EXIT);
461 * Assume there's only one function on the composite device
462 * and enable remote wake for the first interface.
463 * FIXME if the IAD (interface association descriptor) shows
464 * there is more than one function.
466 function_wake_notif(mtu, 0);
468 mtu3_setbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
469 spin_unlock_irqrestore(&mtu->lock, flags);
470 usleep_range(10000, 11000);
471 spin_lock_irqsave(&mtu->lock, flags);
472 mtu3_clrbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
474 spin_unlock_irqrestore(&mtu->lock, flags);
478 static int mtu3_gadget_set_self_powered(struct usb_gadget *gadget,
481 struct mtu3 *mtu = gadget_to_mtu3(gadget);
483 mtu->is_self_powered = !!is_selfpowered;
487 static int mtu3_gadget_pullup(struct usb_gadget *gadget, int is_on)
489 struct mtu3 *mtu = gadget_to_mtu3(gadget);
492 dev_dbg(mtu->dev, "%s (%s) for %sactive device\n", __func__,
493 is_on ? "on" : "off", mtu->is_active ? "" : "in");
495 pm_runtime_get_sync(mtu->dev);
497 /* we'd rather not pullup unless the device is active. */
498 spin_lock_irqsave(&mtu->lock, flags);
501 if (!mtu->is_active) {
502 /* save it for mtu3_start() to process the request */
503 mtu->softconnect = is_on;
504 } else if (is_on != mtu->softconnect) {
505 mtu->softconnect = is_on;
506 mtu3_dev_on_off(mtu, is_on);
509 spin_unlock_irqrestore(&mtu->lock, flags);
510 pm_runtime_put(mtu->dev);
515 static int mtu3_gadget_start(struct usb_gadget *gadget,
516 struct usb_gadget_driver *driver)
518 struct mtu3 *mtu = gadget_to_mtu3(gadget);
521 if (mtu->gadget_driver) {
522 dev_err(mtu->dev, "%s is already bound to %s\n",
523 mtu->g.name, mtu->gadget_driver->driver.name);
527 dev_dbg(mtu->dev, "bind driver %s\n", driver->function);
528 pm_runtime_get_sync(mtu->dev);
530 spin_lock_irqsave(&mtu->lock, flags);
532 mtu->softconnect = 0;
533 mtu->gadget_driver = driver;
535 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
538 spin_unlock_irqrestore(&mtu->lock, flags);
539 pm_runtime_put(mtu->dev);
544 static void stop_activity(struct mtu3 *mtu)
546 struct usb_gadget_driver *driver = mtu->gadget_driver;
549 /* don't disconnect if it's not connected */
550 if (mtu->g.speed == USB_SPEED_UNKNOWN)
553 mtu->g.speed = USB_SPEED_UNKNOWN;
555 /* deactivate the hardware */
556 if (mtu->softconnect) {
557 mtu->softconnect = 0;
558 mtu3_dev_on_off(mtu, 0);
562 * killing any outstanding requests will quiesce the driver;
563 * then report disconnect
565 nuke(mtu->ep0, -ESHUTDOWN);
566 for (i = 1; i < mtu->num_eps; i++) {
567 nuke(mtu->in_eps + i, -ESHUTDOWN);
568 nuke(mtu->out_eps + i, -ESHUTDOWN);
572 spin_unlock(&mtu->lock);
573 driver->disconnect(&mtu->g);
574 spin_lock(&mtu->lock);
578 static int mtu3_gadget_stop(struct usb_gadget *g)
580 struct mtu3 *mtu = gadget_to_mtu3(g);
583 dev_dbg(mtu->dev, "%s\n", __func__);
585 spin_lock_irqsave(&mtu->lock, flags);
588 mtu->gadget_driver = NULL;
590 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
593 spin_unlock_irqrestore(&mtu->lock, flags);
595 synchronize_irq(mtu->irq);
600 mtu3_gadget_set_speed(struct usb_gadget *g, enum usb_device_speed speed)
602 struct mtu3 *mtu = gadget_to_mtu3(g);
605 dev_dbg(mtu->dev, "%s %s\n", __func__, usb_speed_string(speed));
607 spin_lock_irqsave(&mtu->lock, flags);
609 spin_unlock_irqrestore(&mtu->lock, flags);
612 static void mtu3_gadget_async_callbacks(struct usb_gadget *g, bool enable)
614 struct mtu3 *mtu = gadget_to_mtu3(g);
617 dev_dbg(mtu->dev, "%s %s\n", __func__, enable ? "en" : "dis");
619 spin_lock_irqsave(&mtu->lock, flags);
620 mtu->async_callbacks = enable;
621 spin_unlock_irqrestore(&mtu->lock, flags);
624 static const struct usb_gadget_ops mtu3_gadget_ops = {
625 .get_frame = mtu3_gadget_get_frame,
626 .wakeup = mtu3_gadget_wakeup,
627 .set_selfpowered = mtu3_gadget_set_self_powered,
628 .pullup = mtu3_gadget_pullup,
629 .udc_start = mtu3_gadget_start,
630 .udc_stop = mtu3_gadget_stop,
631 .udc_set_speed = mtu3_gadget_set_speed,
632 .udc_async_callbacks = mtu3_gadget_async_callbacks,
635 static void mtu3_state_reset(struct mtu3 *mtu)
638 mtu->ep0_state = MU3D_EP0_STATE_SETUP;
642 mtu->delayed_status = false;
643 mtu->test_mode = false;
646 static void init_hw_ep(struct mtu3 *mtu, struct mtu3_ep *mep,
647 u32 epnum, u32 is_in)
653 INIT_LIST_HEAD(&mep->req_list);
655 sprintf(mep->name, "ep%d%s", epnum,
656 !epnum ? "" : (is_in ? "in" : "out"));
658 mep->ep.name = mep->name;
659 INIT_LIST_HEAD(&mep->ep.ep_list);
661 /* initialize maxpacket as SS */
663 usb_ep_set_maxpacket_limit(&mep->ep, 512);
664 mep->ep.caps.type_control = true;
665 mep->ep.ops = &mtu3_ep0_ops;
666 mtu->g.ep0 = &mep->ep;
668 usb_ep_set_maxpacket_limit(&mep->ep, 1024);
669 mep->ep.caps.type_iso = true;
670 mep->ep.caps.type_bulk = true;
671 mep->ep.caps.type_int = true;
672 mep->ep.ops = &mtu3_ep_ops;
673 list_add_tail(&mep->ep.ep_list, &mtu->g.ep_list);
676 dev_dbg(mtu->dev, "%s, name=%s, maxp=%d\n", __func__, mep->ep.name,
680 mep->ep.caps.dir_in = true;
681 mep->ep.caps.dir_out = true;
683 mep->ep.caps.dir_in = true;
685 mep->ep.caps.dir_out = true;
689 static void mtu3_gadget_init_eps(struct mtu3 *mtu)
693 /* initialize endpoint list just once */
694 INIT_LIST_HEAD(&(mtu->g.ep_list));
696 dev_dbg(mtu->dev, "%s num_eps(1 for a pair of tx&rx ep)=%d\n",
697 __func__, mtu->num_eps);
699 init_hw_ep(mtu, mtu->ep0, 0, 0);
700 for (epnum = 1; epnum < mtu->num_eps; epnum++) {
701 init_hw_ep(mtu, mtu->in_eps + epnum, epnum, 1);
702 init_hw_ep(mtu, mtu->out_eps + epnum, epnum, 0);
706 int mtu3_gadget_setup(struct mtu3 *mtu)
708 mtu->g.ops = &mtu3_gadget_ops;
709 mtu->g.max_speed = mtu->max_speed;
710 mtu->g.speed = USB_SPEED_UNKNOWN;
711 mtu->g.sg_supported = 0;
712 mtu->g.name = MTU3_DRIVER_NAME;
713 mtu->g.irq = mtu->irq;
715 mtu->delayed_status = false;
717 mtu3_gadget_init_eps(mtu);
719 return usb_add_gadget_udc(mtu->dev, &mtu->g);
722 void mtu3_gadget_cleanup(struct mtu3 *mtu)
724 usb_del_gadget_udc(&mtu->g);
727 void mtu3_gadget_resume(struct mtu3 *mtu)
729 dev_dbg(mtu->dev, "gadget RESUME\n");
730 if (mtu->async_callbacks && mtu->gadget_driver && mtu->gadget_driver->resume) {
731 spin_unlock(&mtu->lock);
732 mtu->gadget_driver->resume(&mtu->g);
733 spin_lock(&mtu->lock);
737 /* called when SOF packets stop for 3+ msec or enters U3 */
738 void mtu3_gadget_suspend(struct mtu3 *mtu)
740 dev_dbg(mtu->dev, "gadget SUSPEND\n");
741 if (mtu->async_callbacks && mtu->gadget_driver && mtu->gadget_driver->suspend) {
742 spin_unlock(&mtu->lock);
743 mtu->gadget_driver->suspend(&mtu->g);
744 spin_lock(&mtu->lock);
748 /* called when VBUS drops below session threshold, and in other cases */
749 void mtu3_gadget_disconnect(struct mtu3 *mtu)
751 dev_dbg(mtu->dev, "gadget DISCONNECT\n");
752 if (mtu->async_callbacks && mtu->gadget_driver && mtu->gadget_driver->disconnect) {
753 spin_unlock(&mtu->lock);
754 mtu->gadget_driver->disconnect(&mtu->g);
755 spin_lock(&mtu->lock);
758 mtu3_state_reset(mtu);
759 usb_gadget_set_state(&mtu->g, USB_STATE_NOTATTACHED);
762 void mtu3_gadget_reset(struct mtu3 *mtu)
764 dev_dbg(mtu->dev, "gadget RESET\n");
766 /* report disconnect, if we didn't flush EP state */
767 if (mtu->g.speed != USB_SPEED_UNKNOWN)
768 mtu3_gadget_disconnect(mtu);
770 mtu3_state_reset(mtu);