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>
12 void mtu3_req_complete(struct mtu3_ep *mep,
13 struct usb_request *req, int status)
14 __releases(mep->mtu->lock)
15 __acquires(mep->mtu->lock)
17 struct mtu3_request *mreq;
21 mreq = to_mtu3_request(req);
22 list_del(&mreq->list);
23 if (mreq->request.status == -EINPROGRESS)
24 mreq->request.status = status;
28 spin_unlock(&mtu->lock);
30 /* ep0 makes use of PIO, needn't unmap it */
32 usb_gadget_unmap_request(&mtu->g, req, mep->is_in);
34 dev_dbg(mtu->dev, "%s complete req: %p, sts %d, %d/%d\n", mep->name,
35 req, req->status, mreq->request.actual, mreq->request.length);
37 usb_gadget_giveback_request(&mep->ep, &mreq->request);
39 spin_lock(&mtu->lock);
43 static void nuke(struct mtu3_ep *mep, const int status)
45 struct mtu3_request *mreq = NULL;
48 if (list_empty(&mep->req_list))
51 dev_dbg(mep->mtu->dev, "abort %s's req: sts %d\n", mep->name, status);
57 while (!list_empty(&mep->req_list)) {
58 mreq = list_first_entry(&mep->req_list,
59 struct mtu3_request, list);
60 mtu3_req_complete(mep, &mreq->request, status);
64 static int mtu3_ep_enable(struct mtu3_ep *mep)
66 const struct usb_endpoint_descriptor *desc;
67 const struct usb_ss_ep_comp_descriptor *comp_desc;
68 struct mtu3 *mtu = mep->mtu;
75 comp_desc = mep->comp_desc;
76 mep->type = usb_endpoint_type(desc);
77 mep->maxp = usb_endpoint_maxp(desc);
79 switch (mtu->g.speed) {
81 case USB_SPEED_SUPER_PLUS:
82 if (usb_endpoint_xfer_int(desc) ||
83 usb_endpoint_xfer_isoc(desc)) {
84 interval = desc->bInterval;
85 interval = clamp_val(interval, 1, 16) - 1;
86 if (usb_endpoint_xfer_isoc(desc) && comp_desc)
87 mult = comp_desc->bmAttributes;
90 burst = comp_desc->bMaxBurst;
94 if (usb_endpoint_xfer_isoc(desc) ||
95 usb_endpoint_xfer_int(desc)) {
96 interval = desc->bInterval;
97 interval = clamp_val(interval, 1, 16) - 1;
98 mult = usb_endpoint_maxp_mult(desc) - 1;
102 break; /*others are ignored */
105 dev_dbg(mtu->dev, "%s maxp:%d, interval:%d, burst:%d, mult:%d\n",
106 __func__, mep->maxp, interval, burst, mult);
108 mep->ep.maxpacket = mep->maxp;
110 mep->ep.comp_desc = comp_desc;
112 /* slot mainly affects bulk/isoc transfer, so ignore int */
113 mep->slot = usb_endpoint_xfer_int(desc) ? 0 : mtu->slot;
115 ret = mtu3_config_ep(mtu, mep, interval, burst, mult);
119 ret = mtu3_gpd_ring_alloc(mep);
121 mtu3_deconfig_ep(mtu, mep);
130 static int mtu3_ep_disable(struct mtu3_ep *mep)
132 struct mtu3 *mtu = mep->mtu;
136 /* abort all pending requests */
137 nuke(mep, -ESHUTDOWN);
138 mtu3_deconfig_ep(mtu, mep);
139 mtu3_gpd_ring_free(mep);
143 mep->comp_desc = NULL;
150 static int mtu3_gadget_ep_enable(struct usb_ep *ep,
151 const struct usb_endpoint_descriptor *desc)
158 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
159 pr_debug("%s invalid parameters\n", __func__);
163 if (!desc->wMaxPacketSize) {
164 pr_debug("%s missing wMaxPacketSize\n", __func__);
167 mep = to_mtu3_ep(ep);
170 /* check ep number and direction against endpoint */
171 if (usb_endpoint_num(desc) != mep->epnum)
174 if (!!usb_endpoint_dir_in(desc) ^ !!mep->is_in)
177 dev_dbg(mtu->dev, "%s %s\n", __func__, ep->name);
179 if (mep->flags & MTU3_EP_ENABLED) {
180 dev_WARN_ONCE(mtu->dev, true, "%s is already enabled\n",
185 spin_lock_irqsave(&mtu->lock, flags);
187 mep->comp_desc = ep->comp_desc;
189 ret = mtu3_ep_enable(mep);
195 mep->flags |= MTU3_EP_ENABLED;
199 spin_unlock_irqrestore(&mtu->lock, flags);
201 dev_dbg(mtu->dev, "%s active_ep=%d\n", __func__, mtu->active_ep);
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);
214 if (!(mep->flags & MTU3_EP_ENABLED)) {
215 dev_warn(mtu->dev, "%s is already disabled\n", mep->name);
219 spin_lock_irqsave(&mtu->lock, flags);
220 mtu3_ep_disable(mep);
221 mep->flags &= ~MTU3_EP_ENABLED;
223 spin_unlock_irqrestore(&(mtu->lock), flags);
225 dev_dbg(mtu->dev, "%s active_ep=%d, mtu3 is_active=%d\n",
226 __func__, mtu->active_ep, mtu->is_active);
231 struct usb_request *mtu3_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
233 struct mtu3_ep *mep = to_mtu3_ep(ep);
234 struct mtu3_request *mreq;
236 mreq = kzalloc(sizeof(*mreq), gfp_flags);
240 mreq->request.dma = DMA_ADDR_INVALID;
241 mreq->epnum = mep->epnum;
244 return &mreq->request;
247 void mtu3_free_request(struct usb_ep *ep, struct usb_request *req)
249 kfree(to_mtu3_request(req));
252 static int mtu3_gadget_queue(struct usb_ep *ep,
253 struct usb_request *req, gfp_t gfp_flags)
256 struct mtu3_request *mreq;
267 mep = to_mtu3_ep(ep);
269 mreq = to_mtu3_request(req);
272 if (mreq->mep != mep)
275 dev_dbg(mtu->dev, "%s %s EP%d(%s), req=%p, maxp=%d, len#%d\n",
276 __func__, mep->is_in ? "TX" : "RX", mreq->epnum, ep->name,
277 mreq, ep->maxpacket, mreq->request.length);
279 if (req->length > GPD_BUF_SIZE) {
281 "req length > supported MAX:%d requested:%d\n",
282 GPD_BUF_SIZE, req->length);
286 /* don't queue if the ep is down */
288 dev_dbg(mtu->dev, "req=%p queued to %s while it's disabled\n",
293 mreq->request.actual = 0;
294 mreq->request.status = -EINPROGRESS;
296 ret = usb_gadget_map_request(&mtu->g, req, mep->is_in);
298 dev_err(mtu->dev, "dma mapping failed\n");
302 spin_lock_irqsave(&mtu->lock, flags);
304 if (mtu3_prepare_transfer(mep)) {
309 list_add_tail(&mreq->list, &mep->req_list);
310 mtu3_insert_gpd(mep, mreq);
311 mtu3_qmu_resume(mep);
314 spin_unlock_irqrestore(&mtu->lock, flags);
319 static int mtu3_gadget_dequeue(struct usb_ep *ep, struct usb_request *req)
321 struct mtu3_ep *mep = to_mtu3_ep(ep);
322 struct mtu3_request *mreq = to_mtu3_request(req);
323 struct mtu3_request *r;
326 struct mtu3 *mtu = mep->mtu;
328 if (!ep || !req || mreq->mep != mep)
331 dev_dbg(mtu->dev, "%s : req=%p\n", __func__, req);
333 spin_lock_irqsave(&mtu->lock, flags);
335 list_for_each_entry(r, &mep->req_list, list) {
340 dev_dbg(mtu->dev, "req=%p not queued to %s\n", req, ep->name);
345 mtu3_qmu_flush(mep); /* REVISIT: set BPS ?? */
346 mtu3_req_complete(mep, req, -ECONNRESET);
350 spin_unlock_irqrestore(&mtu->lock, flags);
356 * Set or clear the halt bit of an EP.
357 * A halted EP won't TX/RX any data but will queue requests.
359 static int mtu3_gadget_ep_set_halt(struct usb_ep *ep, int value)
361 struct mtu3_ep *mep = to_mtu3_ep(ep);
362 struct mtu3 *mtu = mep->mtu;
363 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",
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);
406 /* Sets the halt feature with the clear requests ignored */
407 static int mtu3_gadget_ep_set_wedge(struct usb_ep *ep)
409 struct mtu3_ep *mep = to_mtu3_ep(ep);
416 return usb_ep_set_halt(ep);
419 static const struct usb_ep_ops mtu3_ep_ops = {
420 .enable = mtu3_gadget_ep_enable,
421 .disable = mtu3_gadget_ep_disable,
422 .alloc_request = mtu3_alloc_request,
423 .free_request = mtu3_free_request,
424 .queue = mtu3_gadget_queue,
425 .dequeue = mtu3_gadget_dequeue,
426 .set_halt = mtu3_gadget_ep_set_halt,
427 .set_wedge = mtu3_gadget_ep_set_wedge,
430 static int mtu3_gadget_get_frame(struct usb_gadget *gadget)
432 struct mtu3 *mtu = gadget_to_mtu3(gadget);
434 return (int)mtu3_readl(mtu->mac_base, U3D_USB20_FRAME_NUM);
437 static int mtu3_gadget_wakeup(struct usb_gadget *gadget)
439 struct mtu3 *mtu = gadget_to_mtu3(gadget);
442 dev_dbg(mtu->dev, "%s\n", __func__);
444 /* remote wakeup feature is not enabled by host */
445 if (!mtu->may_wakeup)
448 spin_lock_irqsave(&mtu->lock, flags);
449 if (mtu->g.speed >= USB_SPEED_SUPER) {
450 mtu3_setbits(mtu->mac_base, U3D_LINK_POWER_CONTROL, UX_EXIT);
452 mtu3_setbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
453 spin_unlock_irqrestore(&mtu->lock, flags);
454 usleep_range(10000, 11000);
455 spin_lock_irqsave(&mtu->lock, flags);
456 mtu3_clrbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
458 spin_unlock_irqrestore(&mtu->lock, flags);
462 static int mtu3_gadget_set_self_powered(struct usb_gadget *gadget,
465 struct mtu3 *mtu = gadget_to_mtu3(gadget);
467 mtu->is_self_powered = !!is_selfpowered;
471 static int mtu3_gadget_pullup(struct usb_gadget *gadget, int is_on)
473 struct mtu3 *mtu = gadget_to_mtu3(gadget);
476 dev_dbg(mtu->dev, "%s (%s) for %sactive device\n", __func__,
477 is_on ? "on" : "off", mtu->is_active ? "" : "in");
479 /* we'd rather not pullup unless the device is active. */
480 spin_lock_irqsave(&mtu->lock, flags);
483 if (!mtu->is_active) {
484 /* save it for mtu3_start() to process the request */
485 mtu->softconnect = is_on;
486 } else if (is_on != mtu->softconnect) {
487 mtu->softconnect = is_on;
488 mtu3_dev_on_off(mtu, is_on);
491 spin_unlock_irqrestore(&mtu->lock, flags);
496 static int mtu3_gadget_start(struct usb_gadget *gadget,
497 struct usb_gadget_driver *driver)
499 struct mtu3 *mtu = gadget_to_mtu3(gadget);
502 if (mtu->gadget_driver) {
503 dev_err(mtu->dev, "%s is already bound to %s\n",
504 mtu->g.name, mtu->gadget_driver->driver.name);
508 dev_dbg(mtu->dev, "bind driver %s\n", driver->function);
510 spin_lock_irqsave(&mtu->lock, flags);
512 mtu->softconnect = 0;
513 mtu->gadget_driver = driver;
515 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
518 spin_unlock_irqrestore(&mtu->lock, flags);
523 static void stop_activity(struct mtu3 *mtu)
525 struct usb_gadget_driver *driver = mtu->gadget_driver;
528 /* don't disconnect if it's not connected */
529 if (mtu->g.speed == USB_SPEED_UNKNOWN)
532 mtu->g.speed = USB_SPEED_UNKNOWN;
534 /* deactivate the hardware */
535 if (mtu->softconnect) {
536 mtu->softconnect = 0;
537 mtu3_dev_on_off(mtu, 0);
541 * killing any outstanding requests will quiesce the driver;
542 * then report disconnect
544 nuke(mtu->ep0, -ESHUTDOWN);
545 for (i = 1; i < mtu->num_eps; i++) {
546 nuke(mtu->in_eps + i, -ESHUTDOWN);
547 nuke(mtu->out_eps + i, -ESHUTDOWN);
551 spin_unlock(&mtu->lock);
552 driver->disconnect(&mtu->g);
553 spin_lock(&mtu->lock);
557 static int mtu3_gadget_stop(struct usb_gadget *g)
559 struct mtu3 *mtu = gadget_to_mtu3(g);
562 dev_dbg(mtu->dev, "%s\n", __func__);
564 spin_lock_irqsave(&mtu->lock, flags);
567 mtu->gadget_driver = NULL;
569 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
572 spin_unlock_irqrestore(&mtu->lock, flags);
574 synchronize_irq(mtu->irq);
578 static const struct usb_gadget_ops mtu3_gadget_ops = {
579 .get_frame = mtu3_gadget_get_frame,
580 .wakeup = mtu3_gadget_wakeup,
581 .set_selfpowered = mtu3_gadget_set_self_powered,
582 .pullup = mtu3_gadget_pullup,
583 .udc_start = mtu3_gadget_start,
584 .udc_stop = mtu3_gadget_stop,
587 static void mtu3_state_reset(struct mtu3 *mtu)
590 mtu->ep0_state = MU3D_EP0_STATE_SETUP;
594 mtu->delayed_status = false;
595 mtu->test_mode = false;
598 static void init_hw_ep(struct mtu3 *mtu, struct mtu3_ep *mep,
599 u32 epnum, u32 is_in)
605 INIT_LIST_HEAD(&mep->req_list);
607 sprintf(mep->name, "ep%d%s", epnum,
608 !epnum ? "" : (is_in ? "in" : "out"));
610 mep->ep.name = mep->name;
611 INIT_LIST_HEAD(&mep->ep.ep_list);
613 /* initialize maxpacket as SS */
615 usb_ep_set_maxpacket_limit(&mep->ep, 512);
616 mep->ep.caps.type_control = true;
617 mep->ep.ops = &mtu3_ep0_ops;
618 mtu->g.ep0 = &mep->ep;
620 usb_ep_set_maxpacket_limit(&mep->ep, 1024);
621 mep->ep.caps.type_iso = true;
622 mep->ep.caps.type_bulk = true;
623 mep->ep.caps.type_int = true;
624 mep->ep.ops = &mtu3_ep_ops;
625 list_add_tail(&mep->ep.ep_list, &mtu->g.ep_list);
628 dev_dbg(mtu->dev, "%s, name=%s, maxp=%d\n", __func__, mep->ep.name,
632 mep->ep.caps.dir_in = true;
633 mep->ep.caps.dir_out = true;
635 mep->ep.caps.dir_in = true;
637 mep->ep.caps.dir_out = true;
641 static void mtu3_gadget_init_eps(struct mtu3 *mtu)
645 /* initialize endpoint list just once */
646 INIT_LIST_HEAD(&(mtu->g.ep_list));
648 dev_dbg(mtu->dev, "%s num_eps(1 for a pair of tx&rx ep)=%d\n",
649 __func__, mtu->num_eps);
651 init_hw_ep(mtu, mtu->ep0, 0, 0);
652 for (epnum = 1; epnum < mtu->num_eps; epnum++) {
653 init_hw_ep(mtu, mtu->in_eps + epnum, epnum, 1);
654 init_hw_ep(mtu, mtu->out_eps + epnum, epnum, 0);
658 int mtu3_gadget_setup(struct mtu3 *mtu)
662 mtu->g.ops = &mtu3_gadget_ops;
663 mtu->g.max_speed = mtu->max_speed;
664 mtu->g.speed = USB_SPEED_UNKNOWN;
665 mtu->g.sg_supported = 0;
666 mtu->g.name = MTU3_DRIVER_NAME;
668 mtu->delayed_status = false;
670 mtu3_gadget_init_eps(mtu);
672 ret = usb_add_gadget_udc(mtu->dev, &mtu->g);
674 dev_err(mtu->dev, "failed to register udc\n");
679 void mtu3_gadget_cleanup(struct mtu3 *mtu)
681 usb_del_gadget_udc(&mtu->g);
684 void mtu3_gadget_resume(struct mtu3 *mtu)
686 dev_dbg(mtu->dev, "gadget RESUME\n");
687 if (mtu->gadget_driver && mtu->gadget_driver->resume) {
688 spin_unlock(&mtu->lock);
689 mtu->gadget_driver->resume(&mtu->g);
690 spin_lock(&mtu->lock);
694 /* called when SOF packets stop for 3+ msec or enters U3 */
695 void mtu3_gadget_suspend(struct mtu3 *mtu)
697 dev_dbg(mtu->dev, "gadget SUSPEND\n");
698 if (mtu->gadget_driver && mtu->gadget_driver->suspend) {
699 spin_unlock(&mtu->lock);
700 mtu->gadget_driver->suspend(&mtu->g);
701 spin_lock(&mtu->lock);
705 /* called when VBUS drops below session threshold, and in other cases */
706 void mtu3_gadget_disconnect(struct mtu3 *mtu)
708 dev_dbg(mtu->dev, "gadget DISCONNECT\n");
709 if (mtu->gadget_driver && mtu->gadget_driver->disconnect) {
710 spin_unlock(&mtu->lock);
711 mtu->gadget_driver->disconnect(&mtu->g);
712 spin_lock(&mtu->lock);
715 mtu3_state_reset(mtu);
716 usb_gadget_set_state(&mtu->g, USB_STATE_NOTATTACHED);
719 void mtu3_gadget_reset(struct mtu3 *mtu)
721 dev_dbg(mtu->dev, "gadget RESET\n");
723 /* report disconnect, if we didn't flush EP state */
724 if (mtu->g.speed != USB_SPEED_UNKNOWN)
725 mtu3_gadget_disconnect(mtu);
727 mtu3_state_reset(mtu);