patch "usb: dwc3: gadget: Check for IOC/LST bit in TRB->ctrl fields" added to usb-linus

Commit Message

Greg Kroah-Hartman Feb. 13, 2020, 4:31 p.m. UTC

This is a note to let you know that I've just added the patch titled

    usb: dwc3: gadget: Check for IOC/LST bit in TRB->ctrl fields

to my usb git tree which can be found at
    git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb.git
in the usb-linus branch.

The patch will show up in the next release of the linux-next tree
(usually sometime within the next 24 hours during the week.)

The patch will hopefully also be merged in Linus's tree for the
next -rc kernel release.

If you have any questions about this process, please let me know.


From 5ee858975b13a9b40db00f456989a689fdbb296c Mon Sep 17 00:00:00 2001
From: Anurag Kumar Vulisha <[e-mail]>
Date: Mon, 27 Jan 2020 19:30:46 +0000
Subject: usb: dwc3: gadget: Check for IOC/LST bit in TRB->ctrl fields

The current code in dwc3_gadget_ep_reclaim_completed_trb() will
check for IOC/LST bit in the event->status and returns if
IOC/LST bit is set. This logic doesn't work if multiple TRBs
are queued per request and the IOC/LST bit is set on the last
TRB of that request.

Consider an example where a queued request has multiple queued
TRBs and IOC/LST bit is set only for the last TRB. In this case,
the core generates XferComplete/XferInProgress events only for
the last TRB (since IOC/LST are set only for the last TRB). As
per the logic in dwc3_gadget_ep_reclaim_completed_trb()
event->status is checked for IOC/LST bit and returns on the
first TRB. This leaves the remaining TRBs left unhandled.

Similarly, if the gadget function enqueues an unaligned request
with sglist already in it, it should fail the same way, since we
will append another TRB to something that already uses more than
one TRB.

To aviod this, this patch changes the code to check for IOC/LST
bits in TRB->ctrl instead.

At a practical level, this patch resolves USB transfer stalls seen
with adb on dwc3 based HiKey960 after functionfs gadget added
scatter-gather support around v4.20.

Cc: Felipe Balbi <[e-mail]>
Cc: Yang Fei <[e-mail]>
Cc: Thinh Nguyen <[e-mail]>
Cc: Tejas Joglekar <[e-mail]>
Cc: Andrzej Pietrasiewicz <[e-mail]>
Cc: Jack Pham <[e-mail]>
Cc: Todd Kjos <[e-mail]>
Cc: Greg KH <[e-mail]>
Cc: Linux USB List <[e-mail]>
Cc: stable <[e-mail]>
Tested-by: Tejas Joglekar <[e-mail]>
Reviewed-by: Thinh Nguyen <[e-mail]>
Signed-off-by: Anurag Kumar Vulisha <[e-mail]>
[jstultz: forward ported to mainline, reworded commit log, reworked
 to only check trb->ctrl as suggested by Felipe]
Signed-off-by: John Stultz <[e-mail]>
Signed-off-by: Felipe Balbi <[e-mail]>
---
 drivers/usb/dwc3/gadget.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Patch

diff --git a/drivers/usb/dwc3/gadget.c b/drivers/usb/dwc3/gadget.c
index 1b8014ab0b25..1b7d2f9cb673 100644
--- a/drivers/usb/dwc3/gadget.c
+++ b/drivers/usb/dwc3/gadget.c
@@ -2429,7 +2429,8 @@  static int dwc3_gadget_ep_reclaim_completed_trb(struct dwc3_ep *dep,
 	if (event->status & DEPEVT_STATUS_SHORT && !chain)
 		return 1;
 
-	if (event->status & DEPEVT_STATUS_IOC)
+	if ((trb->ctrl & DWC3_TRB_CTRL_IOC) ||
+	    (trb->ctrl & DWC3_TRB_CTRL_LST))
 		return 1;
 
 	return 0;