[PATCH v2] usb: gadget: f_midi: Fixing wMaxPacketSize exceeded issue during MIDI bind retries

[PATCH v2] usb: gadget: f_midi: Fixing wMaxPacketSize exceeded issue during MIDI bind retries

[Selvarasu Ganesan]

The current implementation sets the wMaxPacketSize of bulk in/out
endpoints to 1024 bytes at the end of the f_midi_bind function. However,
in cases where there is a failure in the first midi bind attempt,
consider rebinding. This scenario may encounter an f_midi_bind issue due
to the previous bind setting the bulk endpoint's wMaxPacketSize to 1024
bytes, which exceeds the ep->maxpacket_limit where configured dwc3 TX/RX
FIFO's maxpacket size of 512 bytes for IN/OUT endpoints in support HS
speed only.

Here the term "rebind" in this context refers to attempting to bind the
MIDI function a second time in certain scenarios. The situations where
rebinding is considered include:

 * When there is a failure in the first UDC write attempt, which may be
   caused by other functions bind along with MIDI.
 * Runtime composition change : Example : MIDI,ADB to MIDI. Or MIDI to
   MIDI,ADB.

This commit addresses this issue by resetting the wMaxPacketSize before
endpoint claim. And here there is no need to reset all values in the usb
endpoint descriptor structure, as all members except wMaxPacketSize and
bEndpointAddress have predefined values.

This ensures that restores the endpoint to its expected configuration,
and preventing conflicts with value of ep->maxpacket_limit. It also
aligns with the approach used in other function drivers, which treat
endpoint descriptors as if they were full speed before endpoint claim.

Fixes: 46decc82ffd5 ("usb: gadget: unconditionally allocate hs/ss descriptor in bind operation")
Cc: stable@vger.kernel.org
Signed-off-by: Selvarasu Ganesan <selvarasu.g@samsung.com>
---

Changes in v2:
 - Expanded changelog as per the comment from Greg KH.
 - Link to v1: https://lore.kernel.org/all/20241208152322.1653-1-selvarasu.g@samsung.com/
---
 drivers/usb/gadget/function/f_midi.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/drivers/usb/gadget/function/f_midi.c b/drivers/usb/gadget/function/f_midi.c
index 837fcdfa3840..9b991cf5b0f8 100644
--- a/drivers/usb/gadget/function/f_midi.c
+++ b/drivers/usb/gadget/function/f_midi.c
@@ -907,6 +907,15 @@ static int f_midi_bind(struct usb_configuration *c, struct usb_function *f)
 
 	status = -ENODEV;
 
+	/*
+	 * Reset wMaxPacketSize with maximum packet size of FS bulk transfer before
+	 * endpoint claim. This ensures that the wMaxPacketSize does not exceed the
+	 * limit during bind retries where configured dwc3 TX/RX FIFO's maxpacket
+	 * size of 512 bytes for IN/OUT endpoints in support HS speed only.
+	 */
+	bulk_in_desc.wMaxPacketSize = cpu_to_le16(64);
+	bulk_out_desc.wMaxPacketSize = cpu_to_le16(64);
+
 	/* allocate instance-specific endpoints */
 	midi->in_ep = usb_ep_autoconfig(cdev->gadget, &bulk_in_desc);
 	if (!midi->in_ep)
-- 
2.17.1

RE: [PATCH v2] usb: gadget: f_midi: Fixing wMaxPacketSize exceeded issue during MIDI bind retries

[Alim Akhtar]

Hello Selvarasu,

> -----Original Message-----
> From: Selvarasu Ganesan <selvarasu.g@samsung.com>
> Sent: Saturday, January 18, 2025 11:32 AM
> To: gregkh@linuxfoundation.org; m.grzeschik@pengutronix.de;
> kees@kernel.org; abdul.rahim@myyahoo.com; quic_jjohnson@quicinc.com;
> quic_linyyuan@quicinc.com; linux-usb@vger.kernel.org; linux-
> kernel@vger.kernel.org
> Cc: alim.akhtar@samsung.com; thiagu.r@samsung.com;
> jh0801.jung@samsung.com; dh10.jung@samsung.com;
> naushad@samsung.com; akash.m5@samsung.com;
> rc93.raju@samsung.com; taehyun.cho@samsung.com;
> hongpooh.kim@samsung.com; eomji.oh@samsung.com;
> shijie.cai@samsung.com; Selvarasu Ganesan <selvarasu.g@samsung.com>;
> stable@vger.kernel.org
> Subject: [PATCH v2] usb: gadget: f_midi: Fixing wMaxPacketSize exceeded
> issue during MIDI bind retries
> 
> The current implementation sets the wMaxPacketSize of bulk in/out
> endpoints to 1024 bytes at the end of the f_midi_bind function. However, in
> cases where there is a failure in the first midi bind attempt, consider
> rebinding. This scenario may encounter an f_midi_bind issue due to the
> previous bind setting the bulk endpoint's wMaxPacketSize to 1024 bytes,
> which exceeds the ep->maxpacket_limit where configured dwc3 TX/RX
> FIFO's maxpacket size of 512 bytes for IN/OUT endpoints in support HS
> speed only.
> 
> Here the term "rebind" in this context refers to attempting to bind the MIDI
> function a second time in certain scenarios. The situations where rebinding is
> considered include:
> 
>  * When there is a failure in the first UDC write attempt, which may be
>    caused by other functions bind along with MIDI.
>  * Runtime composition change : Example : MIDI,ADB to MIDI. Or MIDI to
>    MIDI,ADB.
> 
> This commit addresses this issue by resetting the wMaxPacketSize before
> endpoint claim. And here there is no need to reset all values in the usb
> endpoint descriptor structure, as all members except wMaxPacketSize and
> bEndpointAddress have predefined values.
> 
> This ensures that restores the endpoint to its expected configuration, and
> preventing conflicts with value of ep->maxpacket_limit. It also aligns with the
> approach used in other function drivers, which treat endpoint descriptors as
> if they were full speed before endpoint claim.
> 
> Fixes: 46decc82ffd5 ("usb: gadget: unconditionally allocate hs/ss descriptor in
> bind operation")
> Cc: stable@vger.kernel.org
> Signed-off-by: Selvarasu Ganesan <selvarasu.g@samsung.com>
> ---
Reviewed-by: Alim Akhtar <alim.akhtar@samsung.com>

[Snip]
> 2.17.1