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>
9 * This software is licensed under the terms of the GNU General Public
10 * License version 2, as published by the Free Software Foundation, and
11 * may be copied, distributed, and modified under those terms.
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.
22 void mtu3_req_complete(struct mtu3_ep *mep,
23 struct usb_request *req, int status)
24 __releases(mep->mtu->lock)
25 __acquires(mep->mtu->lock)
27 struct mtu3_request *mreq;
31 mreq = to_mtu3_request(req);
32 list_del(&mreq->list);
33 if (mreq->request.status == -EINPROGRESS)
34 mreq->request.status = status;
38 spin_unlock(&mtu->lock);
40 /* ep0 makes use of PIO, needn't unmap it */
42 usb_gadget_unmap_request(&mtu->g, req, mep->is_in);
44 dev_dbg(mtu->dev, "%s complete req: %p, sts %d, %d/%d\n", mep->name,
45 req, req->status, mreq->request.actual, mreq->request.length);
47 usb_gadget_giveback_request(&mep->ep, &mreq->request);
49 spin_lock(&mtu->lock);
53 static void nuke(struct mtu3_ep *mep, const int status)
55 struct mtu3_request *mreq = NULL;
58 if (list_empty(&mep->req_list))
61 dev_dbg(mep->mtu->dev, "abort %s's req: sts %d\n", mep->name, status);
67 while (!list_empty(&mep->req_list)) {
68 mreq = list_first_entry(&mep->req_list,
69 struct mtu3_request, list);
70 mtu3_req_complete(mep, &mreq->request, status);
74 static int mtu3_ep_enable(struct mtu3_ep *mep)
76 const struct usb_endpoint_descriptor *desc;
77 const struct usb_ss_ep_comp_descriptor *comp_desc;
78 struct mtu3 *mtu = mep->mtu;
86 comp_desc = mep->comp_desc;
87 mep->type = usb_endpoint_type(desc);
88 max_packet = usb_endpoint_maxp(desc);
89 mep->maxp = max_packet & GENMASK(10, 0);
91 switch (mtu->g.speed) {
93 case USB_SPEED_SUPER_PLUS:
94 if (usb_endpoint_xfer_int(desc) ||
95 usb_endpoint_xfer_isoc(desc)) {
96 interval = desc->bInterval;
97 interval = clamp_val(interval, 1, 16) - 1;
98 if (usb_endpoint_xfer_isoc(desc) && comp_desc)
99 mult = comp_desc->bmAttributes;
102 burst = comp_desc->bMaxBurst;
106 if (usb_endpoint_xfer_isoc(desc) ||
107 usb_endpoint_xfer_int(desc)) {
108 interval = desc->bInterval;
109 interval = clamp_val(interval, 1, 16) - 1;
110 burst = (max_packet & GENMASK(12, 11)) >> 11;
114 break; /*others are ignored */
117 dev_dbg(mtu->dev, "%s maxp:%d, interval:%d, burst:%d, mult:%d\n",
118 __func__, mep->maxp, interval, burst, mult);
120 mep->ep.maxpacket = mep->maxp;
122 mep->ep.comp_desc = comp_desc;
124 /* slot mainly affects bulk/isoc transfer, so ignore int */
125 mep->slot = usb_endpoint_xfer_int(desc) ? 0 : mtu->slot;
127 ret = mtu3_config_ep(mtu, mep, interval, burst, mult);
131 ret = mtu3_gpd_ring_alloc(mep);
133 mtu3_deconfig_ep(mtu, mep);
142 static int mtu3_ep_disable(struct mtu3_ep *mep)
144 struct mtu3 *mtu = mep->mtu;
148 /* abort all pending requests */
149 nuke(mep, -ESHUTDOWN);
150 mtu3_deconfig_ep(mtu, mep);
151 mtu3_gpd_ring_free(mep);
155 mep->comp_desc = NULL;
162 static int mtu3_gadget_ep_enable(struct usb_ep *ep,
163 const struct usb_endpoint_descriptor *desc)
170 if (!ep || !desc || desc->bDescriptorType != USB_DT_ENDPOINT) {
171 pr_debug("%s invalid parameters\n", __func__);
175 if (!desc->wMaxPacketSize) {
176 pr_debug("%s missing wMaxPacketSize\n", __func__);
179 mep = to_mtu3_ep(ep);
182 /* check ep number and direction against endpoint */
183 if (usb_endpoint_num(desc) != mep->epnum)
186 if (!!usb_endpoint_dir_in(desc) ^ !!mep->is_in)
189 dev_dbg(mtu->dev, "%s %s\n", __func__, ep->name);
191 if (mep->flags & MTU3_EP_ENABLED) {
192 dev_WARN_ONCE(mtu->dev, true, "%s is already enabled\n",
197 spin_lock_irqsave(&mtu->lock, flags);
199 mep->comp_desc = ep->comp_desc;
201 ret = mtu3_ep_enable(mep);
207 mep->flags |= MTU3_EP_ENABLED;
211 spin_unlock_irqrestore(&mtu->lock, flags);
213 dev_dbg(mtu->dev, "%s active_ep=%d\n", __func__, mtu->active_ep);
218 static int mtu3_gadget_ep_disable(struct usb_ep *ep)
220 struct mtu3_ep *mep = to_mtu3_ep(ep);
221 struct mtu3 *mtu = mep->mtu;
224 dev_dbg(mtu->dev, "%s %s\n", __func__, mep->name);
226 if (!(mep->flags & MTU3_EP_ENABLED)) {
227 dev_warn(mtu->dev, "%s is already disabled\n", mep->name);
231 spin_lock_irqsave(&mtu->lock, flags);
232 mtu3_ep_disable(mep);
233 mep->flags &= ~MTU3_EP_ENABLED;
235 spin_unlock_irqrestore(&(mtu->lock), flags);
237 dev_dbg(mtu->dev, "%s active_ep=%d, mtu3 is_active=%d\n",
238 __func__, mtu->active_ep, mtu->is_active);
243 struct usb_request *mtu3_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
245 struct mtu3_ep *mep = to_mtu3_ep(ep);
246 struct mtu3_request *mreq;
248 mreq = kzalloc(sizeof(*mreq), gfp_flags);
252 mreq->request.dma = DMA_ADDR_INVALID;
253 mreq->epnum = mep->epnum;
256 return &mreq->request;
259 void mtu3_free_request(struct usb_ep *ep, struct usb_request *req)
261 kfree(to_mtu3_request(req));
264 static int mtu3_gadget_queue(struct usb_ep *ep,
265 struct usb_request *req, gfp_t gfp_flags)
268 struct mtu3_request *mreq;
279 mep = to_mtu3_ep(ep);
281 mreq = to_mtu3_request(req);
284 if (mreq->mep != mep)
287 dev_dbg(mtu->dev, "%s %s EP%d(%s), req=%p, maxp=%d, len#%d\n",
288 __func__, mep->is_in ? "TX" : "RX", mreq->epnum, ep->name,
289 mreq, ep->maxpacket, mreq->request.length);
291 if (req->length > GPD_BUF_SIZE) {
293 "req length > supported MAX:%d requested:%d\n",
294 GPD_BUF_SIZE, req->length);
298 /* don't queue if the ep is down */
300 dev_dbg(mtu->dev, "req=%p queued to %s while it's disabled\n",
305 mreq->request.actual = 0;
306 mreq->request.status = -EINPROGRESS;
308 ret = usb_gadget_map_request(&mtu->g, req, mep->is_in);
310 dev_err(mtu->dev, "dma mapping failed\n");
314 spin_lock_irqsave(&mtu->lock, flags);
316 if (mtu3_prepare_transfer(mep)) {
321 list_add_tail(&mreq->list, &mep->req_list);
322 mtu3_insert_gpd(mep, mreq);
323 mtu3_qmu_resume(mep);
326 spin_unlock_irqrestore(&mtu->lock, flags);
331 static int mtu3_gadget_dequeue(struct usb_ep *ep, struct usb_request *req)
333 struct mtu3_ep *mep = to_mtu3_ep(ep);
334 struct mtu3_request *mreq = to_mtu3_request(req);
335 struct mtu3_request *r;
338 struct mtu3 *mtu = mep->mtu;
340 if (!ep || !req || mreq->mep != mep)
343 dev_dbg(mtu->dev, "%s : req=%p\n", __func__, req);
345 spin_lock_irqsave(&mtu->lock, flags);
347 list_for_each_entry(r, &mep->req_list, list) {
352 dev_dbg(mtu->dev, "req=%p not queued to %s\n", req, ep->name);
357 mtu3_qmu_flush(mep); /* REVISIT: set BPS ?? */
358 mtu3_req_complete(mep, req, -ECONNRESET);
362 spin_unlock_irqrestore(&mtu->lock, flags);
368 * Set or clear the halt bit of an EP.
369 * A halted EP won't TX/RX any data but will queue requests.
371 static int mtu3_gadget_ep_set_halt(struct usb_ep *ep, int value)
373 struct mtu3_ep *mep = to_mtu3_ep(ep);
374 struct mtu3 *mtu = mep->mtu;
375 struct mtu3_request *mreq;
382 dev_dbg(mtu->dev, "%s : %s...", __func__, ep->name);
384 spin_lock_irqsave(&mtu->lock, flags);
386 if (mep->type == USB_ENDPOINT_XFER_ISOC) {
391 mreq = next_request(mep);
394 * If there is not request for TX-EP, QMU will not transfer
395 * data to TX-FIFO, so no need check whether TX-FIFO
396 * holds bytes or not here
399 dev_dbg(mtu->dev, "req in progress, cannot halt %s\n",
408 dev_dbg(mtu->dev, "%s %s stall\n", ep->name, value ? "set" : "clear");
410 mtu3_ep_stall_set(mep, value);
413 spin_unlock_irqrestore(&mtu->lock, flags);
418 /* Sets the halt feature with the clear requests ignored */
419 static int mtu3_gadget_ep_set_wedge(struct usb_ep *ep)
421 struct mtu3_ep *mep = to_mtu3_ep(ep);
428 return usb_ep_set_halt(ep);
431 static const struct usb_ep_ops mtu3_ep_ops = {
432 .enable = mtu3_gadget_ep_enable,
433 .disable = mtu3_gadget_ep_disable,
434 .alloc_request = mtu3_alloc_request,
435 .free_request = mtu3_free_request,
436 .queue = mtu3_gadget_queue,
437 .dequeue = mtu3_gadget_dequeue,
438 .set_halt = mtu3_gadget_ep_set_halt,
439 .set_wedge = mtu3_gadget_ep_set_wedge,
442 static int mtu3_gadget_get_frame(struct usb_gadget *gadget)
444 struct mtu3 *mtu = gadget_to_mtu3(gadget);
446 return (int)mtu3_readl(mtu->mac_base, U3D_USB20_FRAME_NUM);
449 static int mtu3_gadget_wakeup(struct usb_gadget *gadget)
451 struct mtu3 *mtu = gadget_to_mtu3(gadget);
454 dev_dbg(mtu->dev, "%s\n", __func__);
456 /* remote wakeup feature is not enabled by host */
457 if (!mtu->may_wakeup)
460 spin_lock_irqsave(&mtu->lock, flags);
461 if (mtu->g.speed >= USB_SPEED_SUPER) {
462 mtu3_setbits(mtu->mac_base, U3D_LINK_POWER_CONTROL, UX_EXIT);
464 mtu3_setbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
465 spin_unlock_irqrestore(&mtu->lock, flags);
466 usleep_range(10000, 11000);
467 spin_lock_irqsave(&mtu->lock, flags);
468 mtu3_clrbits(mtu->mac_base, U3D_POWER_MANAGEMENT, RESUME);
470 spin_unlock_irqrestore(&mtu->lock, flags);
474 static int mtu3_gadget_set_self_powered(struct usb_gadget *gadget,
477 struct mtu3 *mtu = gadget_to_mtu3(gadget);
479 mtu->is_self_powered = !!is_selfpowered;
483 static int mtu3_gadget_pullup(struct usb_gadget *gadget, int is_on)
485 struct mtu3 *mtu = gadget_to_mtu3(gadget);
488 dev_dbg(mtu->dev, "%s (%s) for %sactive device\n", __func__,
489 is_on ? "on" : "off", mtu->is_active ? "" : "in");
491 /* we'd rather not pullup unless the device is active. */
492 spin_lock_irqsave(&mtu->lock, flags);
495 if (!mtu->is_active) {
496 /* save it for mtu3_start() to process the request */
497 mtu->softconnect = is_on;
498 } else if (is_on != mtu->softconnect) {
499 mtu->softconnect = is_on;
500 mtu3_dev_on_off(mtu, is_on);
503 spin_unlock_irqrestore(&mtu->lock, flags);
508 static int mtu3_gadget_start(struct usb_gadget *gadget,
509 struct usb_gadget_driver *driver)
511 struct mtu3 *mtu = gadget_to_mtu3(gadget);
514 if (mtu->gadget_driver) {
515 dev_err(mtu->dev, "%s is already bound to %s\n",
516 mtu->g.name, mtu->gadget_driver->driver.name);
520 dev_dbg(mtu->dev, "bind driver %s\n", driver->function);
522 spin_lock_irqsave(&mtu->lock, flags);
524 mtu->softconnect = 0;
525 mtu->gadget_driver = driver;
527 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
530 spin_unlock_irqrestore(&mtu->lock, flags);
535 static void stop_activity(struct mtu3 *mtu)
537 struct usb_gadget_driver *driver = mtu->gadget_driver;
540 /* don't disconnect if it's not connected */
541 if (mtu->g.speed == USB_SPEED_UNKNOWN)
544 mtu->g.speed = USB_SPEED_UNKNOWN;
546 /* deactivate the hardware */
547 if (mtu->softconnect) {
548 mtu->softconnect = 0;
549 mtu3_dev_on_off(mtu, 0);
553 * killing any outstanding requests will quiesce the driver;
554 * then report disconnect
556 nuke(mtu->ep0, -ESHUTDOWN);
557 for (i = 1; i < mtu->num_eps; i++) {
558 nuke(mtu->in_eps + i, -ESHUTDOWN);
559 nuke(mtu->out_eps + i, -ESHUTDOWN);
563 spin_unlock(&mtu->lock);
564 driver->disconnect(&mtu->g);
565 spin_lock(&mtu->lock);
569 static int mtu3_gadget_stop(struct usb_gadget *g)
571 struct mtu3 *mtu = gadget_to_mtu3(g);
574 dev_dbg(mtu->dev, "%s\n", __func__);
576 spin_lock_irqsave(&mtu->lock, flags);
579 mtu->gadget_driver = NULL;
581 if (mtu->ssusb->dr_mode == USB_DR_MODE_PERIPHERAL)
584 spin_unlock_irqrestore(&mtu->lock, flags);
589 static const struct usb_gadget_ops mtu3_gadget_ops = {
590 .get_frame = mtu3_gadget_get_frame,
591 .wakeup = mtu3_gadget_wakeup,
592 .set_selfpowered = mtu3_gadget_set_self_powered,
593 .pullup = mtu3_gadget_pullup,
594 .udc_start = mtu3_gadget_start,
595 .udc_stop = mtu3_gadget_stop,
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");
678 usb_gadget_set_state(&mtu->g, USB_STATE_NOTATTACHED);
683 void mtu3_gadget_cleanup(struct mtu3 *mtu)
685 usb_del_gadget_udc(&mtu->g);
688 void mtu3_gadget_resume(struct mtu3 *mtu)
690 dev_dbg(mtu->dev, "gadget RESUME\n");
691 if (mtu->gadget_driver && mtu->gadget_driver->resume) {
692 spin_unlock(&mtu->lock);
693 mtu->gadget_driver->resume(&mtu->g);
694 spin_lock(&mtu->lock);
698 /* called when SOF packets stop for 3+ msec or enters U3 */
699 void mtu3_gadget_suspend(struct mtu3 *mtu)
701 dev_dbg(mtu->dev, "gadget SUSPEND\n");
702 if (mtu->gadget_driver && mtu->gadget_driver->suspend) {
703 spin_unlock(&mtu->lock);
704 mtu->gadget_driver->suspend(&mtu->g);
705 spin_lock(&mtu->lock);
709 /* called when VBUS drops below session threshold, and in other cases */
710 void mtu3_gadget_disconnect(struct mtu3 *mtu)
712 dev_dbg(mtu->dev, "gadget DISCONNECT\n");
713 if (mtu->gadget_driver && mtu->gadget_driver->disconnect) {
714 spin_unlock(&mtu->lock);
715 mtu->gadget_driver->disconnect(&mtu->g);
716 spin_lock(&mtu->lock);
719 usb_gadget_set_state(&mtu->g, USB_STATE_NOTATTACHED);
722 void mtu3_gadget_reset(struct mtu3 *mtu)
724 dev_dbg(mtu->dev, "gadget RESET\n");
726 /* report disconnect, if we didn't flush EP state */
727 if (mtu->g.speed != USB_SPEED_UNKNOWN)
728 mtu3_gadget_disconnect(mtu);
731 mtu->ep0_state = MU3D_EP0_STATE_SETUP;
735 mtu->delayed_status = false;