Skip to contentSkip to conversation

add gadget quirk to adapt f_fs for DWC3

PATCH Superseded David Cohen 3 participants 21 messages Nov 11, 2013 – Dec 6, 2013

Subsystems (2)

v5 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

v5 cover add gadget quirk to adapt f_fs for DWC3

Hi,

These patches are a proposal to add gadget quirks in an immediate objective to adapt f_fs when using DWC3 controller. But the quirk solution is generic and can be used by other controllers to adapt gadget functions to their non-standard restrictions.

This change is necessary to make Android's adbd service to work on Intel Merrifield with f_fs instead of out-of-tree android gadget.

This new patch set was tested and validated in my environment:
- Intel Merrifield was able to use DWC3/f_fs with adbd service (it wasn't before).

Changes from v4 to v5:
- Added 2 patches from Michal Nazarewicz to address comments from Alan Stern on f_fs driver.

---
David Cohen (3):
usb: gadget: move bitflags to the end of usb_gadget struct
usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget
usb: dwc3: set gadget's quirk ep_out_align_size

Michal Nazarewicz (2):
usb: gadget: f_fs: remove loop from I/O function
usb: f_fs: check quirk to pad epout buf size when not aligned to
maxpacketsize

 drivers/usb/dwc3/gadget.c  |   6 +++
 drivers/usb/gadget/f_fs.c  | 115 +++++++++++++++++++++++----------------------
 include/linux/usb/gadget.h |  35 ++++++++++----
 3 files changed, 91 insertions(+), 65 deletions(-)
Signature · 1 line
1.8.4.rc3
#1 lore raw

PATCH v5 1/5 usb: gadget: move bitflags to the end of usb_gadget struct

This patch moves all bitflags to the end of usb_gadget struct in order to improve readability.

---
 include/linux/usb/gadget.h | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)
include/linux/usb/gadget.h +10 -9
index 942ef5e053bf..23b3bfd0a842 100644
@@ -485,6 +485,11 @@ struct usb_gadget_ops {
  * @max_speed: Maximal speed the UDC can handle.  UDC must support this
  *      and all slower speeds.
  * @state: the state we are now (attached, suspended, configured, etc)
+ * @name: Identifies the controller hardware type.  Used in diagnostics
+ *	and sometimes configuration.
+ * @dev: Driver model state for this abstract device.
+ * @out_epnum: last used out ep number
+ * @in_epnum: last used in ep number
  * @sg_supported: true if we can handle scatter-gather
  * @is_otg: True if the USB device port uses a Mini-AB jack, so that the
  *	gadget driver must provide a USB OTG descriptor.
@@ -497,11 +502,6 @@ struct usb_gadget_ops {
  *	only supports HNP on a different root port.
  * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
  *	enabled HNP support.
- * @name: Identifies the controller hardware type.  Used in diagnostics
- *	and sometimes configuration.
- * @dev: Driver model state for this abstract device.
- * @out_epnum: last used out ep number
- * @in_epnum: last used in ep number
  *
  * Gadgets have a mostly-portable "gadget driver" implementing device
  * functions, handling all usb configurations and interfaces.  Gadget
@@ -530,16 +530,17 @@ struct usb_gadget {
 	enum usb_device_speed		speed;
 	enum usb_device_speed		max_speed;
 	enum usb_device_state		state;
+	const char			*name;
+	struct device			dev;
+	unsigned			out_epnum;
+	unsigned			in_epnum;
+
 	unsigned			sg_supported:1;
 	unsigned			is_otg:1;
 	unsigned			is_a_peripheral:1;
 	unsigned			b_hnp_enable:1;
 	unsigned			a_hnp_support:1;
 	unsigned			a_alt_hnp_support:1;
-	const char			*name;
-	struct device			dev;
-	unsigned			out_epnum;
-	unsigned			in_epnum;
 };
 #define work_to_gadget(w)	(container_of((w), struct usb_gadget, work))
 
Signature · 1 line
1.8.4.rc3
Acked-by on v5 1/5
#2 lore raw

Re: [PATCH v5 1/5] usb: gadget: move bitflags to the end of usb_gadget struct

Quoted 4 lines · David Cohen

This patch moves all bitflags to the end of usb_gadget struct in order to improve readability.

Quoted 57 lines
---
 include/linux/usb/gadget.h | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)
include/linux/usb/gadget.h +10 -9
index 942ef5e053bf..23b3bfd0a842 100644
@@ -485,6 +485,11 @@ struct usb_gadget_ops {
  * @max_speed: Maximal speed the UDC can handle.  UDC must support this
  *      and all slower speeds.
  * @state: the state we are now (attached, suspended, configured, etc)
+ * @name: Identifies the controller hardware type.  Used in diagnostics
+ *	and sometimes configuration.
+ * @dev: Driver model state for this abstract device.
+ * @out_epnum: last used out ep number
+ * @in_epnum: last used in ep number
  * @sg_supported: true if we can handle scatter-gather
  * @is_otg: True if the USB device port uses a Mini-AB jack, so that the
  *	gadget driver must provide a USB OTG descriptor.
@@ -497,11 +502,6 @@ struct usb_gadget_ops {
  *	only supports HNP on a different root port.
  * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
  *	enabled HNP support.
- * @name: Identifies the controller hardware type.  Used in diagnostics
- *	and sometimes configuration.
- * @dev: Driver model state for this abstract device.
- * @out_epnum: last used out ep number
- * @in_epnum: last used in ep number
  *
  * Gadgets have a mostly-portable "gadget driver" implementing device
  * functions, handling all usb configurations and interfaces.  Gadget
@@ -530,16 +530,17 @@ struct usb_gadget {
 	enum usb_device_speed		speed;
 	enum usb_device_speed		max_speed;
 	enum usb_device_state		state;
+	const char			*name;
+	struct device			dev;
+	unsigned			out_epnum;
+	unsigned			in_epnum;
+
 	unsigned			sg_supported:1;
 	unsigned			is_otg:1;
 	unsigned			is_a_peripheral:1;
 	unsigned			b_hnp_enable:1;
 	unsigned			a_hnp_support:1;
 	unsigned			a_alt_hnp_support:1;
-	const char			*name;
-	struct device			dev;
-	unsigned			out_epnum;
-	unsigned			in_epnum;
 };
 #define work_to_gadget(w)	(container_of((w), struct usb_gadget, work))
 
Signature · 1 line
1.8.4.rc3
Signature · 4 lines
Best regards,                                         _     _
.o. | Liege of Serenely Enlightened Majesty of      o' \,=./ `o
..o | Computer Science,  Michał “mina86” Nazarewicz    (o o)
ooo +--<[email protected]>--<xmpp:[email protected]>--ooO--(_)--Ooo--
#3 lore raw

PATCH v5 2/5 usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

In reply to David Cohen

Due to USB controllers may have different restrictions, usb gadget layer needs to provide a generic way to inform gadget functions to complain with non-standard requirements.

This patch adds 'quirk_ep_out_aligned_size' field to struct usb_gadget to inform when controller's epout requires buffer size to be aligned to MaxPacketSize. A helper is also provided to align buffer size when necessary.

---

Michal,

I added prefix 'usb: f_fs: ' to patch's subject. I did not add 'usb: gadget:
f_fs' due to it would be too long.

 include/linux/usb/gadget.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/linux/usb/gadget.h +16 -0
index 23b3bfd0a842..41e8834af57d 100644
@@ -441,6 +441,19 @@ static inline void usb_ep_fifo_flush(struct usb_ep *ep)
 		ep->ops->fifo_flush(ep);
 }
 
+/**
+ * usb_ep_align_maxpacketsize - returns @len aligned to ep's maxpacketsize
+ * @ep: the endpoint whose maxpacketsize is used to align @len
+ * @len: buffer size's length to align to @ep's maxpacketsize
+ *
+ * This helper is used in case it's required for any reason to align buffer's
+ * size to an ep's maxpacketsize.
+ */
+static inline size_t usb_ep_align_maxpacketsize(struct usb_ep *ep, size_t len)
+{
+	return round_up(len, (size_t)ep->desc->wMaxPacketSize);
+}
+
 
 /*-------------------------------------------------------------------------*/
 
@@ -502,6 +515,8 @@ struct usb_gadget_ops {
  *	only supports HNP on a different root port.
  * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
  *	enabled HNP support.
+ * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to
+ *	MaxPacketSize.
  *
  * Gadgets have a mostly-portable "gadget driver" implementing device
  * functions, handling all usb configurations and interfaces.  Gadget
@@ -541,6 +556,7 @@ struct usb_gadget {
 	unsigned			b_hnp_enable:1;
 	unsigned			a_hnp_support:1;
 	unsigned			a_alt_hnp_support:1;
+	unsigned			quirk_ep_out_aligned_size:1;
 };
 #define work_to_gadget(w)	(container_of((w), struct usb_gadget, work))
 
Signature · 1 line
1.8.4.rc3
Acked-by on v5 2/5
#4 lore raw

Re: [PATCH v5 2/5] usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

Quoted 11 lines · David Cohen

Due to USB controllers may have different restrictions, usb gadget layer needs to provide a generic way to inform gadget functions to complain with non-standard requirements.

This patch adds 'quirk_ep_out_aligned_size' field to struct usb_gadget to inform when controller's epout requires buffer size to be aligned to MaxPacketSize. A helper is also provided to align buffer size when necessary.

Quoted 22 lines

---

Michal,

I added prefix 'usb: f_fs: ' to patch's subject. I did not add 'usb: gadget:
f_fs' due to it would be too long.

 include/linux/usb/gadget.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
include/linux/usb/gadget.h +3 -0
index 23b3bfd0a842..41e8834af57d 100644
@@ -441,6 +441,19 @@ static inline void usb_ep_fifo_flush(struct usb_ep *ep)
 		ep->ops->fifo_flush(ep);
 }
 
+/**
+ * usb_ep_align_maxpacketsize - returns @len aligned to ep's maxpacketsize
+ * @ep: the endpoint whose maxpacketsize is used to align @len

include/linux/usb/gadget.h static inline void usb_ep_fifo_flush(struct usb_ep *ep) · line 456

Quoted 10 lines
include/linux/usb/gadget.h +10 -0
+ * @len: buffer size's length to align to @ep's maxpacketsize
+ *
+ * This helper is used in case it's required for any reason to align buffer's
+ * size to an ep's maxpacketsize.
+ */
+static inline size_t usb_ep_align_maxpacketsize(struct usb_ep *ep, size_t len)
+{
+	return round_up(len, (size_t)ep->desc->wMaxPacketSize);
+}
+

Come to think of it, perhaps even better helper would be:

static inline size_t usb_ep_align_maybe(

	struct usb_gadget *gadget, struct usb_ep *ep, size_t len) {
	return gadget->quir_ep_out_aligned_size ?
		round_up(len, (size_t)ep->desc->wMaxPacketSize) : len;
}
Quoted 23 lines
include/linux/usb/gadget.h +3 -0
 /*-------------------------------------------------------------------------*/
 
@@ -502,6 +515,8 @@ struct usb_gadget_ops {
  *	only supports HNP on a different root port.
  * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
  *	enabled HNP support.
+ * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to
+ *	MaxPacketSize.
  *
  * Gadgets have a mostly-portable "gadget driver" implementing device
  * functions, handling all usb configurations and interfaces.  Gadget
@@ -541,6 +556,7 @@ struct usb_gadget {
 	unsigned			b_hnp_enable:1;
 	unsigned			a_hnp_support:1;
 	unsigned			a_alt_hnp_support:1;
+	unsigned			quirk_ep_out_aligned_size:1;
 };
 #define work_to_gadget(w)	(container_of((w), struct usb_gadget, work))
 
Signature · 1 line
1.8.4.rc3
Signature · 4 lines
Best regards,                                         _     _
.o. | Liege of Serenely Enlightened Majesty of      o' \,=./ `o
..o | Computer Science,  Michał “mina86” Nazarewicz    (o o)
ooo +--<[email protected]>--<xmpp:[email protected]>--ooO--(_)--Ooo--
#5 lore raw

Re: [PATCH v5 2/5] usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

Quoted 50 lines · Michal Nazarewicz
Quoted 11 lines · David Cohen

Due to USB controllers may have different restrictions, usb gadget layer needs to provide a generic way to inform gadget functions to complain with non-standard requirements.

This patch adds 'quirk_ep_out_aligned_size' field to struct usb_gadget to inform when controller's epout requires buffer size to be aligned to MaxPacketSize. A helper is also provided to align buffer size when necessary.

Quoted 22 lines

---

Michal,

I added prefix 'usb: f_fs: ' to patch's subject. I did not add 'usb: gadget:
f_fs' due to it would be too long.

  include/linux/usb/gadget.h | 16 ++++++++++++++++
  1 file changed, 16 insertions(+)
include/linux/usb/gadget.h +3 -0
index 23b3bfd0a842..41e8834af57d 100644
@@ -441,6 +441,19 @@ static inline void usb_ep_fifo_flush(struct usb_ep *ep)
  		ep->ops->fifo_flush(ep);
  }
 
+/**
+ * usb_ep_align_maxpacketsize - returns @len aligned to ep's maxpacketsize
+ * @ep: the endpoint whose maxpacketsize is used to align @len

include/linux/usb/gadget.h static inline void usb_ep_fifo_flush(struct usb_ep *ep) · line 456

Quoted 10 lines
include/linux/usb/gadget.h +10 -0
+ * @len: buffer size's length to align to @ep's maxpacketsize
+ *
+ * This helper is used in case it's required for any reason to align buffer's
+ * size to an ep's maxpacketsize.
+ */
+static inline size_t usb_ep_align_maxpacketsize(struct usb_ep *ep, size_t len)
+{
+	return round_up(len, (size_t)ep->desc->wMaxPacketSize);
+}
+

Come to think of it, perhaps even better helper would be:

Quoted 5 lines

static inline size_t usb_ep_align_maybe(

	struct usb_gadget *gadget, struct usb_ep *ep, size_t len) {
	return gadget->quir_ep_out_aligned_size ?
		round_up(len, (size_t)ep->desc->wMaxPacketSize) : len;
}

The CPU time to check unsigned:1 and possibly jump is about the same as round_up() itself. For readability matters, we can round_up() directly.

Br, David

#6 lore raw

Re: [PATCH v5 2/5] usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

Quoted 11 lines · David Cohen
Quoted 7 lines · Michal Nazarewicz

Come to think of it, perhaps even better helper would be:

static inline size_t usb_ep_align_maybe(

	struct usb_gadget *gadget, struct usb_ep *ep, size_t len) {
	return gadget->quir_ep_out_aligned_size ?
		round_up(len, (size_t)ep->desc->wMaxPacketSize) : len;
}

The CPU time to check unsigned:1 and possibly jump is about the same as round_up() itself. For readability matters, we can round_up() directly.

I was proposing to have this function and than not have functions check for the flag. I.e. instead of

	if (gadget->quirk_ep_out_aligned_size)
		len = usb_ep_align_maxpacketsize(ep, len);

the code would just be:

	len = usb_ep_align_maybe(gadget, ep, len);
Signature · 4 lines
Best regards,                                         _     _
.o. | Liege of Serenely Enlightened Majesty of      o' \,=./ `o
..o | Computer Science,  Michał “mina86” Nazarewicz    (o o)
ooo +--<[email protected]>--<xmpp:[email protected]>--ooO--(_)--Ooo--
#7 lore raw

Re: [PATCH v5 2/5] usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

Quoted 16 lines · Michal Nazarewicz
Quoted 11 lines · David Cohen
Quoted 7 lines · Michal Nazarewicz

Come to think of it, perhaps even better helper would be:

static inline size_t usb_ep_align_maybe(

	struct usb_gadget *gadget, struct usb_ep *ep, size_t len) {
	return gadget->quir_ep_out_aligned_size ?
		round_up(len, (size_t)ep->desc->wMaxPacketSize) : len;
}

The CPU time to check unsigned:1 and possibly jump is about the same as round_up() itself. For readability matters, we can round_up() directly.

I was proposing to have this function and than not have functions check for the flag. I.e. instead of

Quoted 6 lines
	if (gadget->quirk_ep_out_aligned_size)
		len = usb_ep_align_maxpacketsize(ep, len);

the code would just be:

	len = usb_ep_align_maybe(gadget, ep, len);

that looks very good to me, do we have a version with that already ?

Signature · 1 line
balbi
#8 lore raw

Re: [PATCH v5 2/5] usb: gadget: add quirk_ep_out_aligned_size field to struct usb_gadget

Quoted 17 lines · Felipe Balbi
Quoted 16 lines · Michal Nazarewicz
Quoted 11 lines · David Cohen
Quoted 7 lines · Michal Nazarewicz

Come to think of it, perhaps even better helper would be:

static inline size_t usb_ep_align_maybe(

	struct usb_gadget *gadget, struct usb_ep *ep, size_t len) {
	return gadget->quir_ep_out_aligned_size ?
		round_up(len, (size_t)ep->desc->wMaxPacketSize) : len;
}

The CPU time to check unsigned:1 and possibly jump is about the same as round_up() itself. For readability matters, we can round_up() directly.

I was proposing to have this function and than not have functions check for the flag. I.e. instead of

Quoted 8 lines
Quoted 6 lines
	if (gadget->quirk_ep_out_aligned_size)
		len = usb_ep_align_maxpacketsize(ep, len);

the code would just be:

	len = usb_ep_align_maybe(gadget, ep, len);

that looks very good to me, do we have a version with that already ?

Nope. But as soon as soon as you finish the whole review, I can resend new version with all changes at once.

Br, David

#9 lore raw

PATCH v5 3/5 usb: gadget: f_fs: remove loop from I/O function

In reply to David Cohen

From: Michal Nazarewicz <[email protected]>

When endpoint changes (due to it being disabled or alt setting changed), mimic the action as if the change happened after the request has been queued, instead of retrying with the new endpoint.

---
 drivers/usb/gadget/f_fs.c | 94 +++++++++++++++++++++--------------------------
 1 file changed, 41 insertions(+), 53 deletions(-)
drivers/usb/gadget/f_fs.c +41 -53
index 75e4b7846a8d..f1563c47e0c2 100644
@@ -756,74 +756,61 @@ static ssize_t ffs_epfile_io(struct file *file,
 {
 	struct ffs_epfile *epfile = file->private_data;
 	struct ffs_ep *ep;
-	char *data = NULL;
 	ssize_t ret;
+	char *data;
 	int halt;
 
-	goto first_try;
-	do {
-		spin_unlock_irq(&epfile->ffs->eps_lock);
-		mutex_unlock(&epfile->mutex);
+	/* Are we still active? */
+	if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
+		ret = -ENODEV;
+		goto error;
+	}
 
-first_try:
-		/* Are we still active? */
-		if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
-			ret = -ENODEV;
+	/* Wait for endpoint to be enabled */
+	ep = epfile->ep;
+	if (!ep) {
+		if (file->f_flags & O_NONBLOCK) {
+			ret = -EAGAIN;
 			goto error;
 		}
 
-		/* Wait for endpoint to be enabled */
-		ep = epfile->ep;
-		if (!ep) {
-			if (file->f_flags & O_NONBLOCK) {
-				ret = -EAGAIN;
-				goto error;
-			}
-
-			if (wait_event_interruptible(epfile->wait,
-						     (ep = epfile->ep))) {
-				ret = -EINTR;
-				goto error;
-			}
-		}
-
-		/* Do we halt? */
-		halt = !read == !epfile->in;
-		if (halt && epfile->isoc) {
-			ret = -EINVAL;
+		if (wait_event_interruptible(epfile->wait, (ep = epfile->ep))) {
+			ret = -EINTR;
 			goto error;
 		}
+	}
 
-		/* Allocate & copy */
-		if (!halt && !data) {
-			data = kzalloc(len, GFP_KERNEL);
-			if (unlikely(!data))
-				return -ENOMEM;
+	/* Do we halt? */
+	halt = !read == !epfile->in;
+	if (halt && epfile->isoc) {
+		ret = -EINVAL;
+		goto error;
+	}
 
-			if (!read &&
-			    unlikely(__copy_from_user(data, buf, len))) {
-				ret = -EFAULT;
-				goto error;
-			}
-		}
+	/* Allocate & copy */
+	if (!halt) {
+		data = kmalloc(len, GFP_KERNEL);
+		if (unlikely(!data))
+			return -ENOMEM;
 
-		/* We will be using request */
-		ret = ffs_mutex_lock(&epfile->mutex,
-				     file->f_flags & O_NONBLOCK);
-		if (unlikely(ret))
+		if (!read && unlikely(copy_from_user(data, buf, len))) {
+			ret = -EFAULT;
 			goto error;
+		}
+	}
 
-		/*
-		 * We're called from user space, we can use _irq rather then
-		 * _irqsave
-		 */
-		spin_lock_irq(&epfile->ffs->eps_lock);
+	/* We will be using request */
+	ret = ffs_mutex_lock(&epfile->mutex, file->f_flags & O_NONBLOCK);
+	if (unlikely(ret))
+		goto error;
+	spin_lock_irq(&epfile->ffs->eps_lock);
 
-		/*
-		 * While we were acquiring mutex endpoint got disabled
-		 * or changed?
-		 */
-	} while (unlikely(epfile->ep != ep));
+	/* While we were acquiring mutex endpoint got disabled or changed. */
+	if (epfile->ep != ep) {
+		ret = -ESHUTDOWN;
+		spin_unlock_irq(&epfile->ffs->eps_lock);
+		goto error_unlock;
+	}
 
 	/* Halt */
 	if (unlikely(halt)) {
@@ -858,6 +845,7 @@ first_try:
 		}
 	}
 
+error_unlock:
 	mutex_unlock(&epfile->mutex);
 error:
 	kfree(data);
Signature · 1 line
1.8.4.rc3
#10 lore raw

Re: [PATCH v5 3/5] usb: gadget: f_fs: remove loop from I/O function

Quoted 69 lines · David Cohen

From: Michal Nazarewicz <[email protected]>

When endpoint changes (due to it being disabled or alt setting changed), mimic the action as if the change happened after the request has been queued, instead of retrying with the new endpoint.

---
  drivers/usb/gadget/f_fs.c | 94 +++++++++++++++++++++--------------------------
  1 file changed, 41 insertions(+), 53 deletions(-)
drivers/usb/gadget/f_fs.c +13 -28
index 75e4b7846a8d..f1563c47e0c2 100644
@@ -756,74 +756,61 @@ static ssize_t ffs_epfile_io(struct file *file,
  {
  	struct ffs_epfile *epfile = file->private_data;
  	struct ffs_ep *ep;
-	char *data = NULL;
  	ssize_t ret;
+	char *data;
  	int halt;
 
-	goto first_try;
-	do {
-		spin_unlock_irq(&epfile->ffs->eps_lock);
-		mutex_unlock(&epfile->mutex);
+	/* Are we still active? */
+	if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
+		ret = -ENODEV;
+		goto error;
+	}
 
-first_try:
-		/* Are we still active? */
-		if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
-			ret = -ENODEV;
+	/* Wait for endpoint to be enabled */
+	ep = epfile->ep;
+	if (!ep) {
+		if (file->f_flags & O_NONBLOCK) {
+			ret = -EAGAIN;
  			goto error;
  		}
 
-		/* Wait for endpoint to be enabled */
-		ep = epfile->ep;
-		if (!ep) {
-			if (file->f_flags & O_NONBLOCK) {
-				ret = -EAGAIN;
-				goto error;
-			}
-
-			if (wait_event_interruptible(epfile->wait,
-						     (ep = epfile->ep))) {
-				ret = -EINTR;
-				goto error;
-			}
-		}
-
-		/* Do we halt? */
-		halt = !read == !epfile->in;
-		if (halt && epfile->isoc) {
-			ret = -EINVAL;
+		if (wait_event_interruptible(epfile->wait, (ep = epfile->ep))) {
+			ret = -EINTR;
  			goto error;

drivers/usb/gadget/f_fs.c static ssize_t ffs_epfile_io(struct file *file, · line 784

Quoted 10 lines
drivers/usb/gadget/f_fs.c +3 -5
  		}
+	}
 
-		/* Allocate & copy */
-		if (!halt && !data) {
-			data = kzalloc(len, GFP_KERNEL);
-			if (unlikely(!data))
-				return -ENOMEM;
+	/* Do we halt? */
+	halt = !read == !epfile->in;

One curiosity here. This patch prints the following warning:

In file included from (...)/drivers/usb/gadget/g_ffs.c:55:0:
(...)/drivers/usb/gadget/f_fs.c: In function 'ffs_epfile_io.isra.18':
(...)/drivers/usb/gadget/f_fs.c:837:15: warning: 'data_len' may be used uninitialized in this function [-Wmaybe-uninitialized]

But if we do this dummy change on it:

@@ -782,7 +782,10 @@ static ssize_t ffs_epfile_io(struct file *file,

        }

        /* Do we halt? */

- halt = !read == !epfile->in;
+ if (!read == !epfile->in)
+ halt = 1;
+ else

+               halt = 0;
        if (halt && epfile->isoc) {
                ret = -EINVAL;
                goto error;

The warning goes away. This false-positive warning comes out of this gcc version:

$ i686-linux-android-gcc --version
i686-linux-android-gcc (GCC) 4.7

Br, David Cohen

Quoted 61 lines
drivers/usb/gadget/f_fs.c +25 -20
+	if (halt && epfile->isoc) {
+		ret = -EINVAL;
+		goto error;
+	}
 
-			if (!read &&
-			    unlikely(__copy_from_user(data, buf, len))) {
-				ret = -EFAULT;
-				goto error;
-			}
-		}
+	/* Allocate & copy */
+	if (!halt) {
+		data = kmalloc(len, GFP_KERNEL);
+		if (unlikely(!data))
+			return -ENOMEM;
 
-		/* We will be using request */
-		ret = ffs_mutex_lock(&epfile->mutex,
-				     file->f_flags & O_NONBLOCK);
-		if (unlikely(ret))
+		if (!read && unlikely(copy_from_user(data, buf, len))) {
+			ret = -EFAULT;
  			goto error;
+		}
+	}
 
-		/*
-		 * We're called from user space, we can use _irq rather then
-		 * _irqsave
-		 */
-		spin_lock_irq(&epfile->ffs->eps_lock);
+	/* We will be using request */
+	ret = ffs_mutex_lock(&epfile->mutex, file->f_flags & O_NONBLOCK);
+	if (unlikely(ret))
+		goto error;
+	spin_lock_irq(&epfile->ffs->eps_lock);
 
-		/*
-		 * While we were acquiring mutex endpoint got disabled
-		 * or changed?
-		 */
-	} while (unlikely(epfile->ep != ep));
+	/* While we were acquiring mutex endpoint got disabled or changed. */
+	if (epfile->ep != ep) {
+		ret = -ESHUTDOWN;
+		spin_unlock_irq(&epfile->ffs->eps_lock);
+		goto error_unlock;
+	}
 
  	/* Halt */
  	if (unlikely(halt)) {
@@ -858,6 +845,7 @@ first_try:
  		}
  	}
 
+error_unlock:
  	mutex_unlock(&epfile->mutex);
  error:
  	kfree(data);
#11 lore raw

PATCH 3/5 usb: gadget: f_fs: remove loop from I/O function

In reply to David Cohen

When endpoint changes (due to it being disabled or alt setting changed), mimic the action as if the change happened after the request has been queued, instead of retrying with the new endpoint.

---
 drivers/usb/gadget/f_fs.c | 94 ++++++++++++++++++++---------------------------
 1 file changed, 40 insertions(+), 54 deletions(-)

Fixed checkpatch.pl issues pointed out by David.

drivers/usb/gadget/f_fs.c +40 -54
index 0658908..6cb0b22 100644
@@ -758,73 +758,59 @@ static ssize_t ffs_epfile_io(struct file *file,
 	ssize_t ret;
 	int halt;
 
-	goto first_try;
-	do {
-		spin_unlock_irq(&epfile->ffs->eps_lock);
-		mutex_unlock(&epfile->mutex);
+	/* Are we still active? */
+	if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
+		ret = -ENODEV;
+		goto error;
+	}
 
-first_try:
-		/* Are we still active? */
-		if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
-			ret = -ENODEV;
+	/* Wait for endpoint to be enabled */
+	ep = epfile->ep;
+	if (!ep) {
+		if (file->f_flags & O_NONBLOCK) {
+			ret = -EAGAIN;
 			goto error;
 		}
 
-		/* Wait for endpoint to be enabled */
-		ep = epfile->ep;
-		if (!ep) {
-			if (file->f_flags & O_NONBLOCK) {
-				ret = -EAGAIN;
-				goto error;
-			}
-
-			if (wait_event_interruptible(epfile->wait,
-						     (ep = epfile->ep))) {
-				ret = -EINTR;
-				goto error;
-			}
-		}
-
-		/* Do we halt? */
-		halt = !read == !epfile->in;
-		if (halt && epfile->isoc) {
-			ret = -EINVAL;
+		ret = wait_event_interruptible(epfile->wait, (ep = epfile->ep));
+		if (ret) {
+			ret = -EINTR;
 			goto error;
 		}
+	}
 
-		/* Allocate & copy */
-		if (!halt && !data) {
-			data = kzalloc(len, GFP_KERNEL);
-			if (unlikely(!data))
-				return -ENOMEM;
+	/* Do we halt? */
+	halt = !read == !epfile->in;
+	if (halt && epfile->isoc) {
+		ret = -EINVAL;
+		goto error;
+	}
 
-			if (!read &&
-			    unlikely(__copy_from_user(data, buf, len))) {
-				ret = -EFAULT;
-				goto error;
-			}
-		}
+	/* Allocate & copy */
+	if (!halt) {
+		data = kmalloc(len, GFP_KERNEL);
+		if (unlikely(!data))
+			return -ENOMEM;
 
-		/* We will be using request */
-		ret = ffs_mutex_lock(&epfile->mutex,
-				     file->f_flags & O_NONBLOCK);
-		if (unlikely(ret))
+		if (!read && unlikely(copy_from_user(data, buf, len))) {
+			ret = -EFAULT;
 			goto error;
+		}
+	}
 
-		/*
-		 * We're called from user space, we can use _irq rather then
-		 * _irqsave
-		 */
-		spin_lock_irq(&epfile->ffs->eps_lock);
+	/* We will be using request */
+	ret = ffs_mutex_lock(&epfile->mutex, file->f_flags & O_NONBLOCK);
+	if (unlikely(ret))
+		goto error;
 
-		/*
-		 * While we were acquiring mutex endpoint got disabled
-		 * or changed?
-		 */
-	} while (unlikely(epfile->ep != ep));
+	spin_lock_irq(&epfile->ffs->eps_lock);
 
-	/* Halt */
-	if (unlikely(halt)) {
+	if (epfile->ep != ep) {
+		/* In the meantime, endpoint got disabled or changed. */
+		ret = -ESHUTDOWN;
+		spin_unlock_irq(&epfile->ffs->eps_lock);
+	} else if (halt) {
+		/* Halt */
 		if (likely(epfile->ep == ep) && !WARN_ON(!ep->ep))
 			usb_ep_set_halt(ep->ep);
 		spin_unlock_irq(&epfile->ffs->eps_lock);
Signature · 1 line
1.8.4.1
#12 lore raw

Re: [PATCHv5.1 3/5] usb: gadget: f_fs: remove loop from I/O function

Quoted 6 lines · Michal Nazarewicz

When endpoint changes (due to it being disabled or alt setting changed), mimic the action as if the change happened after the request has been queued, instead of retrying with the new endpoint.

pretty obvious patch, looks good.

Signature · 1 line
balbi
#13 lore raw

PATCH v5 4/5 usb: f_fs: check quirk to pad epout buf size when not aligned to maxpacketsize

In reply to David Cohen

From: Michal Nazarewicz <[email protected]>

Check gadget.quirk_ep_out_aligned_size to decide if buffer size requires to be aligned to maxpacketsize of an out endpoint. ffs_epfile_io() needs to pad epout buffer to match above condition if quirk is found.

---
 drivers/usb/gadget/f_fs.c | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
drivers/usb/gadget/f_fs.c +19 -4
index f1563c47e0c2..c49288778fe0 100644
@@ -755,8 +755,9 @@ static ssize_t ffs_epfile_io(struct file *file,
 			     char __user *buf, size_t len, int read)
 {
 	struct ffs_epfile *epfile = file->private_data;
+	struct usb_gadget *gadget = epfile->ffs->gadget;
 	struct ffs_ep *ep;
-	ssize_t ret;
+	ssize_t ret, data_len;
 	char *data;
 	int halt;
 
@@ -789,7 +790,14 @@ static ssize_t ffs_epfile_io(struct file *file,
 
 	/* Allocate & copy */
 	if (!halt) {
-		data = kmalloc(len, GFP_KERNEL);
+		/*
+		 * Controller requires buffer size to be aligned to
+		 * maxpacketsize of an out endpoint.
+		 */
+		data_len = read && gadget->quirk_ep_out_aligned_size ?
+			usb_ep_align_maxpacketsize(ep->ep, len) : len;
+
+		data = kmalloc(data_len, GFP_KERNEL);
 		if (unlikely(!data))
 			return -ENOMEM;
 
@@ -826,7 +834,7 @@ static ssize_t ffs_epfile_io(struct file *file,
 		req->context  = &done;
 		req->complete = ffs_epfile_io_complete;
 		req->buf      = data;
-		req->length   = len;
+		req->length   = data_len;
 
 		ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
 
@@ -838,9 +846,16 @@ static ssize_t ffs_epfile_io(struct file *file,
 			ret = -EINTR;
 			usb_ep_dequeue(ep->ep, req);
 		} else {
+			/*
+			 * XXX We may end up silently droping data here.
+			 * Since data_len (i.e. req->length) may be bigger
+			 * than len (after being rounded up to maxpacketsize),
+			 * we may end up with more data then user space has
+			 * space for.
+			 */
 			ret = ep->status;
 			if (read && ret > 0 &&
-			    unlikely(copy_to_user(buf, data, ret)))
+			    unlikely(copy_to_user(buf, data, min(ret, len))))
 				ret = -EFAULT;
 		}
 	}
Signature · 1 line
1.8.4.rc3
#14 lore raw

PATCH 4/5 check quirk to pad epout buf size when not aligned to maxpacketsize

Check gadget.quirk_ep_out_aligned_size to decide if buffer size requires to be aligned to maxpacketsize of an out endpoint. ffs_epfile_io() needs to pad epout buffer to match above condition if quirk is found.

---
 drivers/usb/gadget/f_fs.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
Quoted 6 lines · David Cohen

One curiosity here. This patch prints the following warning:

In file included from (...)/drivers/usb/gadget/g_ffs.c:55:0:
(...)/drivers/usb/gadget/f_fs.c: In function 'ffs_epfile_io.isra.18':
(...)/drivers/usb/gadget/f_fs.c:837:15: warning: 'data_len' may be used uninitialized in this function [-Wmaybe-uninitialized]

With the below code, this should no longer be a problem.

Also fixes issues pointed out by Alan.

drivers/usb/gadget/f_fs.c +9 -1
index 6cb0b22..9aa3200 100644
@@ -753,6 +753,7 @@ static ssize_t ffs_epfile_io(struct file *file,
 			     char __user *buf, size_t len, int read)
 {
 	struct ffs_epfile *epfile = file->private_data;
+	struct usb_gadget *gadget = epfile->ffs->gadget;
 	struct ffs_ep *ep;
 	char *data = NULL;
 	ssize_t ret;
@@ -788,7 +789,14 @@ static ssize_t ffs_epfile_io(struct file *file,
 
 	/* Allocate & copy */
 	if (!halt) {
-		data = kmalloc(len, GFP_KERNEL);
+		/*
+		 * Controller requires buffer size to be aligned to
+		 * maxpacketsize of an out endpoint.
+		 */
+		size_t data_len = read && gadget->quirk_ep_out_aligned_size ?
+			usb_ep_align_maxpacketsize(ep->ep, len) : len;
+
+		data = kmalloc(data_len, GFP_KERNEL);
 		if (unlikely(!data))
 			return -ENOMEM;
 
Signature · 1 line
1.8.4.1
#15 lore raw

Re: [PATCHv5.1 4/5] check quirk to pad epout buf size when not aligned to maxpacketsize

Hi Michal,

Quoted 12 lines · Michal Nazarewicz

Check gadget.quirk_ep_out_aligned_size to decide if buffer size requires to be aligned to maxpacketsize of an out endpoint. ffs_epfile_io() needs to pad epout buffer to match above condition if quirk is found.

---
  drivers/usb/gadget/f_fs.c | 10 +++++++++-
  1 file changed, 9 insertions(+), 1 deletion(-)
Quoted 2 lines · David Cohen

One curiosity here. This patch prints the following warning:

Quoted 8 lines
Quoted 4 lines

In file included from (...)/drivers/usb/gadget/g_ffs.c:55:0:
(...)/drivers/usb/gadget/f_fs.c: In function 'ffs_epfile_io.isra.18':
(...)/drivers/usb/gadget/f_fs.c:837:15: warning: 'data_len' may be used uninitialized in this function [-Wmaybe-uninitialized]

With the below code, this should no longer be a problem.

Also fixes issues pointed out by Alan.

You need to update req->length otherwise it's going to crash DWC3. I'd rather to keep your previous version.

Br, David

#16 lore raw

Re: [PATCHv5.1 4/5] check quirk to pad epout buf size when not aligned to maxpacketsize

Quoted 2 lines · David Cohen

You need to update req->length otherwise it's going to crash DWC3. I'd rather to keep your previous version.

That's unfortunate. Do you want me to resend it or will you just send a v6 of your whole series?

Signature · 4 lines
Best regards,                                         _     _
.o. | Liege of Serenely Enlightened Majesty of      o' \,=./ `o
..o | Computer Science,  Michał “mina86” Nazarewicz    (o o)
ooo +--<[email protected]>--<xmpp:[email protected]>--ooO--(_)--Ooo--
#17 lore raw

Re: [PATCHv5.1 4/5] check quirk to pad epout buf size when not aligned to maxpacketsize

Quoted 6 lines · Michal Nazarewicz
Quoted 2 lines · David Cohen

You need to update req->length otherwise it's going to crash DWC3. I'd rather to keep your previous version.

That's unfortunate. Do you want me to resend it or will you just send a v6 of your whole series?

Alan disagreed and proposed a good approach to fix req->length inside DWC3. We can keep this patch of yours but I'll need to change mine to DWC3. I'll send a v6 with update on my patch.

Br, David

#18 lore raw

Re: [PATCHv5.1 4/5] check quirk to pad epout buf size when not aligned to maxpacketsize

Quoted 11 lines · David Cohen
Quoted 6 lines · Michal Nazarewicz
Quoted 2 lines · David Cohen

You need to update req->length otherwise it's going to crash DWC3. I'd rather to keep your previous version.

That's unfortunate. Do you want me to resend it or will you just send a v6 of your whole series?

Alan disagreed and proposed a good approach to fix req->length inside DWC3. We can keep this patch of yours but I'll need to change mine to DWC3. I'll send a v6 with update on my patch.

I rather update req->length on the functions. They own the buffer anyway

Signature · 1 line
balbi
#19 lore raw

PATCH v5 5/5 usb: dwc3: set gadget's quirk ep_out_align_size

In reply to David Cohen

DWC3 requires epout to have buffer size aligned to MaxPacketSize value. This patch sets necessary quirk for it.

---
 drivers/usb/dwc3/gadget.c | 6 ++++++
 1 file changed, 6 insertions(+)
drivers/usb/dwc3/gadget.c +6 -0
index 5452c0fce360..b85ec110d6a0 100644
@@ -2600,6 +2600,12 @@ int dwc3_gadget_init(struct dwc3 *dwc)
 	dwc->gadget.name		= "dwc3-gadget";
 
 	/*
+	 * Per databook, DWC3 needs buffer size to be aligned to MaxPacketSize
+	 * on ep out.
+	 */
+	dwc->gadget.quirk_ep_out_aligned_size = true;
+
+	/*
 	 * REVISIT: Here we should clear all pending IRQs to be
 	 * sure we're starting from a well known location.
 	 */
Signature · 1 line
1.8.4.rc3
#20 lore raw

Re: [PATCH v5 5/5] usb: dwc3: set gadget's quirk ep_out_align_size

Quoted 4 lines · David Cohen

DWC3 requires epout to have buffer size aligned to MaxPacketSize value. This patch sets necessary quirk for it.

looks good

Signature · 1 line
balbi